Skip to content

Frequently Asked Questions

👉 What is CRken?

CRken is an AI-based code-review assistant for GitLab, developed by the API4AI Team. It integrates with GitLab using webhooks to provide automated code reviews.

👉 Which programming languages are supported?

CRken supports a wide range of programming languages, including but not limited to Python, JavaScript, Java, Kotlin, Swift, C#, C++, Ruby, and PHP. The AI model is designed to understand and review code in these languages effectively.

👉 How do I subscribe to CRken?

CRken offers two pricing models via the RapidAPI marketplace:

👉 Can I use CRken on-premises?

Yes, enterprise customers can request access to an on-premises version of CRken. Contact us to get a quote.

👉 How does CRken integrate with GitLab?

CRken integrates with GitLab through webhooks. You need to set up a webhook in your GitLab project to enable CRken to review your code changes automatically. For detailed setup instructions, see GitLab Integration.

👉 How does CRken access my GitLab project?

CRken accesses your GitLab project using an Access Token. You need to set up a project or group token with at least developer-level permissions and the "api" scope.

💡 Tip: We recommend creating a project or group token with a descriptive name, such as CRken Code Reviewer, because code review comments will be authored by the GitLab Bot under this name.

This token should be configured in the webhook settings via the header X-A4A-GITLAB-TOKEN.

For more detailed instructions on setting up the token, see GitLab Token Setup.

👉 What events trigger CRken to review code?

CRken can be triggered by two types of events in GitLab:

  • Merge Request events: Automatically reviews changes when a Merge Request is created or updated.
  • Comment events: Reviews changes when a comment containing the trigger word /crken is made.

👉 How can I configure CRken?

CRken can be configured using HTTP headers or a .crken.yml configuration file in your repository. This allows you to set parameters like target files, language, and additional instructions for the AI model.

👉 How to pass extra instructions to CRken?

You can pass extra instructions to CRken in two ways:

  • Configuration File: Add a key instructions in the .crken.yml configuration file in your repository root. For example:
    .crken.yml
    instructions: "Do not focus on code style, highlight only errors."
  • Merge Request Comments: Include the /crken keyword in your comments along with additional instructions. For example: 
    /crken Check only security issues.

👉 Which files will be reviewed?

CRken reviews files that are part of the Merge Request in your GitLab project.

The files to be reviewed depend on your configuration. You can specify target files using regular expressions via webhook headers or in the .crken.yml configuration file. By default, CRken reviews files containing source code written in popular programming languages (such as Python, C/C++, C#, Java, Kotlin, Swift, PHP, Go, Bash/Shell, JavaScript/TypeScript).

For more detailed information about target file configuration, see Review target settings.

👉 What should I do if I have a strict firewall?

If you have a strict firewall, you need to add the IP address 34.88.129.98 to your whitelist. CRken will send requests from this IP address, so whitelisting it will ensure proper communication.

👉 How can I use a custom OpenAI address?

For users opting for the BYOL (Bring Your Own License) ChatGPT version of CRken, you have the flexibility to specify a custom OpenAI API host. This is particularly useful if you are using a self-hosted or enterprise version of OpenAI's API.

To set a custom OpenAI address, you can configure it in the webhook settings or in the .crken.yml configuration file in your repository. For example:

  • Webhook header:
    Set X-A4A-TARGET-EXTRA to https://your-custom-openai-address.com in the webkook settings
  • Configuration File:
    .crken.yml
    openai-host: "https://your-custom-openai-address.com"

Ensure that the endpoint is accessible and properly configured to handle requests from CRken. This allows you to leverage your own OpenAI infrastructure while using CRken for code reviews.

👉 Are there example reviews?

Yes, we provide several examples that demonstrate code reviews generated by CRken directly in the GitLab interface. You can find these examples in our Examples section.

👉 How do I contact support?

You can contact the CRken support team via email at crken@api4.ai or through Telegram at https://t.me/a4a_support_bot.