Set up code review with Syntic Code
Syntic Code reviews code from your terminal: your uncommitted changes, your branch, or a pull request. You can also run a review as a step in your CI pipeline. Posting findings to a pull request uses the GitHub command-line tool gh on your computer; a Syntic-hosted review bot is not available yet.
The review commands
| Command | What it reviews |
|---|---|
/review | Your current changes, or a pull request if you give its number. |
/code-review [low|medium|high|max] | A bug hunt that runs in the background. Higher levels report more, including less certain findings. |
/ultrareview | Three passes (correctness, security, tests) merged into one list by severity. |
/security-review | Security problems in your branch’s changes. See Automated security reviews. |
/pr-comments | Pulls in the comments reviewers left on the current pull request. |
Set up reviews on your computer
Install and sign in
Install instructions are coming soon; see Install Syntic Code. Any paid plan works.
Install the GitHub command-line tool (optional)
To review pull requests by number, or to post findings as pull request comments with /code-review --comment, install gh and sign in to it with your GitHub account. Merge requests on GitLab use glab for the commands that support it.
Run your first review
In the repository, type /review for your local changes, or /review 123 for pull request 123.
Set up reviews in CI
Add a credential to your CI secrets
A refresh token or an API key. See API keys and environment variables.
Add a review step
Install Syntic Code in the job (install steps are coming soon) and run syntic -p with a review instruction and --permission-mode plan, which keeps the run read-only.
Use the output
Add --output-format json and have the pipeline fail, warn or post the summary, as your team prefers.
--fix on /code-review and /ultrareview applies changes to your working copy. Review the diff before you commit. Nothing is pushed for you without your OK.