Install/run via CLI
CLI mode is best suited for immediate, one-time code reviews.
Last updated
Was this helpful?
CLI mode is best suited for immediate, one-time code reviews.
Last updated
Was this helpful?
Prerequisites: Before proceeding, ensure you've completed all necessary AI Code Review Agent.
Start Docker: Ensure Docker is running on your machine.
Repository Download: GitHub repository to your machine.
Extract and Navigate:
Extract the downloaded .zip file to a preferred location.
Navigate to the extracted folder and then to the “cra-scripts” subfolder.
Note the full path to the “cra-scripts” folder for later use.
Open Command Line:
Use Bash for Linux and macOS.
Use PowerShell for Windows.
Set Directory:
Change the current directory in Bash/PowerShell to the “cra-scripts” folder.
Example command: cd [Path to cra-scripts folder]
Adjust the path based on your extraction location.
Configure Properties:
Set mandatory properties:
mode = cli
pr_url
bito_cli.bito.access_key
git.provider
git.access_token
Optional properties (can be skipped or set as needed):
git.domain
code_feedback
static_analysis
dependency_check
dependency_check.snyk_auth_token
review_scope
exclude_branches
exclude_files
exclude_draft_pr
Run the Agent:
On Linux/macOS in Bash: Run ./bito-cra.sh bito-cra.properties
On Windows in PowerShell: Run ./bito-cra.ps1 bito-cra.properties
Final Steps:
The script may prompt values of mandatory/optional properties if they are not preconfigured.
Upon completion, a code review comment is automatically posted on the Pull Request specified in the pr_url property.
Open the bito-cra.properties file in a text editor from the “cra-scripts” folder. Detailed information for each property is provided on page.
Note: Detailed information for each property is provided on page.
Check the guide to learn more about creating the access tokens needed to configure the Agent.
Note: To improve efficiency, the AI Code Review Agent is disabled by default for pull requests involving the "main" branch. This prevents unnecessary processing and token usage, as changes to the "main" branch are typically already reviewed in release or feature branches. To change this default behavior and include the "main" branch, please .