Arcanist home
Documentation
Browse documentation

Reference

Use the CLI

The Arcanist command-line tool lets you set up a repository and request reviews from a terminal or coding agent. You need Node.js 22 or newer.

Set up your repository

Run the setup command from your repository:

npx --yes @tryarcanist/cli@latest setup

Setup installs the arcanist command and starts sign-in. Enter the displayed code in your browser and approve access. Follow the returned instructions to connect GitHub and prepare the repository.

For a coding agent, add --json. The output gives the next action and any approval link. You approve sign-in and GitHub access yourself.

npx --yes @tryarcanist/cli@latest setup --json

Review local commits

Commit your changes, then run:

arcanist review

A local review compares your committed changes with the repository's default branch. Uncommitted changes are not included. Local reviews require a paid plan or a pilot and a token with write access.

For output a coding agent can read, use:

arcanist review --json

Read the recommendation and findings, apply any fixes, and commit them before requesting another review.

Sign in for automation

For a machine without a browser, create a Write token under Settings, then CLI. Pass the token through standard input to arcanist auth login --token-stdin. Do not put it in a command argument or commit it to your repository.

A Read token can list reviews, sessions, and events. It cannot start a review.

Run arcanist --help for available commands, or read the CLI reference.

Arcanist documentation