Agent Configuration: bito-cra.properties File

Setting up your agent: understanding the bito-cra.properties file

Note: This file is only available for people who are using the self-hosted version of AI Code Review Agent.

The bito-cra.properties file offers a comprehensive range of options for configuring the AI Code Review Agent, enhancing its flexibility and adaptability to various workflow requirements.

bito-cra.properties Available Options

Property Name
Supported Values
Is Mandatory?
Description

mode

  • cli

  • server

Yes

Whether to run the Docker container in CLI mode for a one-time code review or as a webhooks service to continuously monitor for code review requests.

pr_url

Pull request URL in GitLab, GitHub and Bitbucket

Yes, if the mode is CLI.

The pull request provides files with changes and the actual code modifications. When the mode is set to server, the pr_url is received either through a webhook call or via a REST API call.

This release only supports webhook calls; other REST API calls are not yet supported.

code_feedback

  • True

  • False

No

Setting it to True activates general code review comments to identify functional issues. If set to False, general code review will not be conducted.

bito_cli.bito.access_key

A valid Bito Access Key generated through Bito's web UI.

Learn More

Yes

Bito Access Key is an alternative to standard email and OTP authentication.

git.provider

  • GITLAB

  • GITHUB

  • BITBUCKET

Yes, if the mode is CLI.

The name of git repository provider.

git.access_token

A valid Git access token provided by GITLAB or GITHUB or BITBUCKET

Yes

You can use a personal access token in place of a password when authenticating to GitHub/GitLab/BitBucket in the command line or with the API.

git.domain

A URL where Git is hosted.

No

It is used to enter the custom URL of self-hosted GitHub/GitLab Enterprise.

static_analysis

  • True

  • False

No

Enable or disable static code analysis, which is used to uncover functional issues in the code.

static_analysis_tool

  • fb_infer

  • astral_ruff

  • mypy

No

Comma-separated list of static analysis tools to run (e.g., fb_infer,astral_ruff,mypy).

linters_feedback

  • True

  • False

No

Enables feedback from linters like ESLint, golangci-lint, and Astral Ruff.

secret_scanner_feedback

  • True

  • False

No

Enables detection of secrets in code. For example, passwords, API keys, sensitive information, etc.

dependency_check

  • True

  • False

No

This feature is designed to identify security vulnerabilities in open-source dependency packages, specifically for JS/TS/Node.JS and GoLang. Without this input, reviews for security vulnerabilities will not be conducted.

dependency_check.snyk_auth_token

A valid authentication token for accessing Snyk's cloud-based security database.

No

If not provided, access to Snyk's cloud-based security database for checking security vulnerabilities in open-source dependency packages will not be available.

code_context

  • True

  • False

No

Enables enhanced code context awareness.

server_port

A valid and available TCP port number.

No

This is applicable when the mode is set to server. If not specified, the default value is 10051.

review_comments

  • 1

  • 2

No

Set the value to 1 to display the code review in a single post, or 2 to show code review as inline comments, placing suggestions directly beneath the corresponding lines in each file for clearer guidance on improvements.

The default value is 2.

review_scope

  • security

  • performance

  • scalability

  • codeorg

  • codeoptimize

No

Specialized commands to perform detailed analyses on specific aspects of your code. You can provide comma-separated values to perform multiple types of code analysis simultaneously. Learn more

include_source_branches

Glob/regex pattern.

No

Comma-separated list of branch patterns (glob/regex) to allow as pull request sources.

include_target_branches

Glob/regex pattern.

No

Comma-separated list of branch patterns (glob/regex) to allow as pull request targets.

exclude_files

Glob/regex pattern.

No

A list of files/folders that the AI Code Review Agent will not review if they are present in the diff.

By default, these files are excluded: *.xml, *.json, *.properties, .gitignore, *.yml, *.md Learn more

exclude_draft_pr

  • True

  • False

No

A binary setting that enables/disables automated review of pull requests (PR) based on the draft status. The default value is True which skips automated review of draft PR. Learn more

cra_version

  • latest

  • Any specific version tag

No

Sets the agent version to run (latest or a specific version tag).

post_as_request_changes

  • True

  • False

No

Posts feedback as 'Request changes' review comments. Depending on your organization's Git settings, you may need to resolve all comments before merging.

support_email

Email address

No

Contact email shown in error messages.

suggestion_mode

  • essential

  • comprehensive

No

Controls AI suggestion verbosity. Available options are essential and comprehensive.

In Essential mode, only critical issues are posted as inline comments, and other issues appear in the main review summary under "Additional issues".

In Comprehensive mode, Bito also includes minor suggestion and potential nitpicks as inline comments.

Last updated

Was this helpful?