2.0 ● DOCSreference

Documentation

Everything you need to get started with CodeComments. The GitHub App reviews PRs automatically. The CLI reviews local diffs before you push. Configuration is optional.

Quick start

Install the GitHub App

Go to the GitHub Marketplace and install CodeComments on your repositories.

Install GitHub App

Open a pull request

Push code and open a PR as you normally would. No configuration files, no setup wizard.

Get your review

CodeComments reads the diff, finds real issues, and posts line-by-line comments directly on your PR.

Pick your entry point

→

CLI

Review a local git diff before you push. Same engine, same findings, drops into CI. Exit code 1 on any P1.

CLI reference

→

Configuration

Drop .commentsoncode.yml at the repo root to gate reviews, skip paths, or add custom pre-merge checks.

Configuration reference

→

Troubleshooting

Review didn't appear? Too many findings? CLI 401? Start here.

Troubleshooting

Supported platforms

GitHubAvailable

CLIAvailable

GitLabComing soon

BitbucketComing soon

Review format

Every comment posted by CodeComments carries one of four severity labels. See configuration for the full list.

[CRITICAL]Blocks merge. Correctness bug, security issue, or regression.

SQL injection via unsanitized user input

[WARNING]Should fix. Logic smell, likely bug, or policy violation.

Missing null check on response.data

[INFO]Worth knowing. Observation, context, or non-blocking concern.

Function exceeds 80 lines — consider extracting

[SUGGESTION]Optional. Style, refactor, or nice-to-have. Dashboard only.

Rename "data" to "userProfiles" for clarity

API

Public API documentation is on the roadmap. Today, the only supported integrations are the GitHub App and the CLI.