Ultrareview CLI reference
Every command, flag and exit code the ultrareview CLI answers, generated from the command tree itself.
CLI reference
Generated from the command tree, so it cannot describe a flag that does not exist. For how to use these together, read Ultrareview from the terminal.
Commands
| Command | What it does |
|---|---|
ultrareview config explain | Show every setting and which layer supplied it. |
ultrareview config init | Write a starter .ultrareview, refusing to replace one that is already there. |
ultrareview config schema | Print the JSON Schema for that file, for an editor to complete against. |
ultrareview config validate [<path>] | Check a repository's .ultrareview file the way the review would read it. No network, no login. |
ultrareview doctor | Check settings, reachability, scopes and expiry, all at once. Works signed out and offline. |
ultrareview notes list | The notes your team has written, and what each one applies to. |
ultrareview notes show <heading> | One note, in full. |
ultrareview pr findings | What a review found, and whether it should stop a build. |
ultrareview pr history | Every review of one pull request, newest first. |
ultrareview pr review | Posts a review comment your team will see, and once it starts nothing can stop it. The work runs on the server. |
ultrareview pr status | What became of one review request. |
ultrareview review | Review the branch you are on, here, before there is a pull request. Uses your team's settings. |
ultrareview reviews list | Recent reviews across the organization. |
Flags
| Flag | Takes a value | What it means |
|---|---|---|
--allow-incomplete | no | Report a review that covered less than it should have, instead of failing on it. |
--allow-stale | no | Read a review of a different commit anyway. |
--base | yes | What to compare against. Defaults to the branch your remote calls its default. |
--base-url | yes | The service host. Only a self-hosted installation needs this. |
--fail-on | yes | Lowest severity that fails a build, or never. |
--force | no | Review the commit again even if it already was; replace an existing file (config init). |
--format | yes | How to print: text, json or sarif. |
--help | no | Print help for the command and stop. |
--hook-exit | no | Answer with the codes an agent hook speaks: 2 blocks, 1 reports without blocking, 0 proceeds. Without it a hook reads findings as a non-blocking error and a usage error as a block, which is the inversion in both directions. |
--json | no | Shorthand for --format json. |
--limit | yes | How many entries a list shows. |
--model | yes | Review on a different model, this once. Nothing is stored. |
--no-context | no | Review without your team's settings, deliberately. |
--poll | yes | How often to ask again while waiting. |
--pr | yes | The pull request number. |
--profile | yes | The review lens, by profile name. |
--repo | yes | The repository, as GitHub spells it: owner/name. |
--run | yes | The review run to read. |
--state | yes | Show only runs in one state. |
--timeout | yes | How long to keep waiting before giving up. |
--token | yes | The API token. Prefer ULTRAREVIEW_TOKEN; a command line lands in shell history. |
--version | no | Print the version and stop. |
--wait | no | Keep watching until the review ends. |
Exit codes
Every command answers with one of these, so a build script can act without parsing output.
| Code | Meaning |
|---|---|
| 0 | Nothing worth stopping for. |
| 1 | Findings at or above your threshold. |
| 2 | The command was used wrongly. |
| 3 | The review covered less than it should have. |
| 4 | Not authenticated: no token, expired, or revoked. |
| 5 | The service or the network refused. Transient by nature, so this is the one worth retrying. |
| 6 | This machine has no model access. A local condition, fixed locally, so retrying changes nothing. |
| 7 | Authenticated, but not permitted. Ask an administrator; retrying changes nothing. |
| 130 | Interrupted by a signal, following the shell convention of 128 plus the signal number. |