CodeJackRabbit CLI reference

Binary names: codejackrabbit and cjr. Install the current artifact from the download page, then run cjr <command>.

Host and key resolution order: flags, CODEJACKRABBIT_HOST_URL or CODEJACKRABBIT_API_KEY, stored login, then https://api.codejackrabbit.com. With no key and no explicit host, review stays local automatically.

Interactive terminal

On a real terminal the CLI uses its signed presentation: an amber CJR banner, findings grouped by severity with colored badges, a progress spinner on stderr during reviews and browser login, and status glyphs in doctor. Missing input is asked for interactively: code new prompts for the task (or read it from stdin with prompt -), and code ask <task> prompts for the question.

Presentation never changes the contract. Colors and the spinner turn off automatically when output is piped, in CI, in --agent mode, or when NO_COLOR is set; FORCE_COLOR=1 forces colors on. Piped output stays plain text, and --agent NDJSON is byte-for-byte the same in every environment. Prompts only appear when stdin is a terminal; scripts keep the non-interactive usage errors.

auth

codejackrabbit auth signup --email <email> [--name <name>] [--org <organization>] [--host-url <url>] [--agent]
codejackrabbit auth login [--api-key <key>] [--host-url <url>] [--region us|eu]
                          [--self-hosted] [--no-browser] [--agent]
codejackrabbit auth logout [--agent]
codejackrabbit auth status [--agent]
codejackrabbit auth org [organization] [--agent]

auth signup starts account creation for the configured host. In managed-connected deployments it directs you to the one global JackAI account and never asks for a local product password; in isolated or federated deployments it creates the native account and organization on that host and stores the issued API key like a login. Accounts can also be created in the browser at /signup on the API host. Plans and payments are managed on the JackAI platform; see the SaaS platform guide.

Without an API key, login starts a loopback browser flow against the server. Production servers can delegate to GitHub OAuth; development servers can enable the explicit CJR_OAUTH_DEV=1 code flow. Token exchange and refresh use the server RPC surface.

review

codejackrabbit review [--local] [--deep [focus]] [--light] [--fresh]
  [--committed|--uncommitted] [--include-untracked]
  [--base <branch>|--base-commit <sha>] [--dir <path>]
  [--changelist <id>] [--remote owner/repo --source-branch <branch>]
  [--type all|committed|uncommitted] [--config <file>]
  [--agent] [--show-prompts] [--fail-on minor|major|critical]
  [--api-key <key>] [--host-url <url>] [--region us|eu] [--use-credits]
codejackrabbit review findings [--clear]

Exit code 1 means the review failed or the configured severity gate tripped. Findings alone do not fail when the gate is none. --agent emits NDJSON events. A second unchanged review may reuse the previous internal state locally or on the server; --fresh forces recomputation.

Pull request helpers

codejackrabbit pullrequest <number|url> --show-prompts [--agent]
codejackrabbit pullrequest <number|url> --show-threads [--agent]

config

codejackrabbit config [--generate|--detailed] [--profile quiet|chill|assertive|default]
codejackrabbit config validate [file] [--json]
codejackrabbit config inspect [--agent]
codejackrabbit config apply <proposal> --base <sha256|none> [--dry-run] [--yes]
codejackrabbit config --agent [--profile <profile>]

Apply merges a validated proposal but refuses when the current file hash no longer equals --base.

doctor, stats and usage

doctor checks Node, Git, configuration, login, server health and installed external tools. stats --rebuild rescans local history. usage reports the server counters for the active key and organization.

learnings and generators

codejackrabbit learnings list
codejackrabbit learnings add [--suppress <rule>] [--path <glob>] [instruction...]
codejackrabbit learnings delete <id>
codejackrabbit generate docstrings|unit-tests|sequence-diagram|vocabulary

code: cloud coding tasks

codejackrabbit code ls [--status <state>] [--repo owner/name] [--all] [--agent]
codejackrabbit code new [prompt...] [--plan] [--resume] [--agent]
codejackrabbit handoff --summary <path|-> [--plan <file>] [--resume] [--agent]
codejackrabbit code show <task> [--agent]
codejackrabbit code resume [task] [--last] [--message <text|->] [--steer <text>]
                            [--answer <text|->] [--agent]
codejackrabbit code ask <task> <question...> [--follow-up <turn>] [--agent]
codejackrabbit code plan <task> [--approve] [--agent]
codejackrabbit code implement <task> [--agent]
codejackrabbit code apply <task> [--agent]
codejackrabbit code cancel <task> [--agent]
codejackrabbit code push <task> [--stacked] [--agent]
codejackrabbit code autopilot on|off|resume|status (<task>|--pr <number|url>) [--agent]
codejackrabbit code skills import [path] [--scope personal|organization] [--yes]

Plan approval uses the current plan version and SHA-256. A plan author cannot approve their own plan unless the task setting allows it, but may implement it directly.

skills, update and completion

codejackrabbit skills [--agent]
codejackrabbit skills --confirm <plan-hash>
codejackrabbit update [--check]
codejackrabbit completion powershell|bash|zsh
codejackrabbit complete [<prefix>]
codejackrabbit --version

update checks the private release channel. Installed binaries are directed to the signed release artifact for their platform; internal source checkouts update in place and refuse a dirty checkout, reinstalls dependencies and rebuilds the current platform distribution.