MenuCLI reference

CLI reference

Use Oaink review data in your own agent harness or CI workflow, with local analysis and machine-readable output.

On this page

Use the CLI

The CLI exposes review data for your own agent or CI workflow. Pro CLI access is planned for release. Deterministic review commands do not require a model key.

Command help

Read command help locally for the options supported by your installed version.

sh
oaink help

Local execution

Review commands run locally. Use --daemon to connect to a running local service.

Repository access

Repository access uses GITHUB_TOKEN, GH_TOKEN or your GitHub CLI sign-in. Oaink account access and model credentials are separate.

Review data

Run deep static analysis on a pull request and request machine-readable output for your own workflow.

sh
oaink analyze owner/repository#123 --json

Read a draft

Read the local review draft without publishing it.

sh
oaink draft show owner/repository#123 --json

Preview feedback

Preview feedback before choosing to publish it.

sh
oaink draft preview owner/repository#123 --json

Diagnostics

Inspect local setup when analysis is unavailable.

sh
oaink doctor

Configuration

Inspect the effective local project configuration.

sh
oaink config print --json

Local service

Run the local review service in the foreground.

sh
oaink serve

Connection status

Check the local review connection.

sh
oaink status

Stop the local service

Stop a running local review service.

sh
oaink stop

Repair analysis setup

Use the diagnostics output for the setup or repair action required by your installation.

Process results

Successful commands exit zero. Errors describe a command or setup failure, not a verdict on the pull request. Data goes to standard output and diagnostics go to standard error.