Everything agentarivm does, in the order you meet it. Run any command with
--help for its own options, and --config <path> anywhere to point at a
configuration file other than ~/.config/agentarivm/agentarivm.yml.
| Command |
What it does |
agentarivm init |
Write a starter config, resolving git, gh and the Claude Code binary to real paths on this machine. --force overwrites an existing one. |
agentarivm config check |
Does this config load in this build? Cheap, and the thing to run before restarting after an edit. |
agentarivm config migrate --from <version> |
Bring a config written by an older release up to what this build needs. agentarivm upgrade runs it for you; you would only run it by hand after restoring an old config. |
agentarivm doctor |
Check the machine end to end: paths, executables, TLS, GitHub, licence, disk. --verbose for the long form. |
agentarivm service install |
Install and start the job that keeps the manager running — launchd on macOS, systemd --user on Linux. |
agentarivm service status |
Is it loaded, is it running, is it healthy. |
sudo agentarivm service install |
The same, but a service the machine starts at boot. Runs as SUDO_USER, or --user <login>. Upgrades then need sudo too. |
agentarivm service uninstall |
Stop it and remove the job. Leaves everything else — this is almost certainly the one you want. |
agentarivm uninstall |
Remove Agentarivm itself. Lists what goes and what stays, then asks. Keeps your config and database. |
agentarivm uninstall --purge |
The same, and also deletes your config, database and device CA. Un-pairs every phone. |
agentarivm serve |
Run the manager in the foreground. The service runs this for you. |
agentarivm reconcile |
Make the database agree with the machine again — after a crash, a manual git operation, or a worktree deleted by hand. |
| Command |
What it does |
agentarivm login |
Sign in with a GitHub device code. Required once per machine. |
agentarivm account status |
Which plan this manager runs under, and until when. |
agentarivm account upgrade indie|pro [--yearly] |
Open checkout for a paid plan, then wait for it to take effect. --no-wait returns straight away. |
agentarivm account refresh |
Pick up a plan changed elsewhere — the billing portal, another machine — without signing in again. |
agentarivm account billing |
Open the billing portal — card, invoices, cancellation. |
agentarivm logout |
Sign out and forget the cached entitlement. |
| Command |
What it does |
agentarivm pair --name "<device>" |
Mint a one-time pairing code and QR for a named device. |
agentarivm devices |
List paired devices, when each was last seen. |
agentarivm devices revoke <name> |
Revoke one. Its token and certificate stop working immediately. |
agentarivm enroll <name> --out <dir> |
Enrol a device here and write its certificate bundle, for a desktop client. |
| Command |
What it does |
agentarivm project list |
Registered repositories. |
agentarivm project add <owner>/<repo> [--profile <name>] |
Register one, with a setup profile. |
agentarivm project remove <owner>/<repo> |
Unregister it. Clones and worktrees stay. |
| Command |
What it does |
agentarivm actors |
Who may start a task by labelling an issue. |
agentarivm actors add <login> |
Allow a GitHub user. Empty means nobody — that is the default. |
agentarivm actors remove <login> |
Withdraw it. |
agentarivm dispatch-token create "<what for>" |
A credential a CI workflow uses to say “look at this issue now”. |
agentarivm dispatch-token list / revoke <id> |
Audit and revoke them. |
| Command |
What it does |
agentarivm upgrade |
Install the newest release, after saying what it would change — including which paired apps it would affect. Refuses while a task is running. |
agentarivm upgrade --force |
Upgrade anyway, interrupting running tasks. |
agentarivm upgrade --yes |
Do not stop to confirm a breaking API change. |
Every command prints a one-line notice when a newer release exists. See
Upgrading and uninstalling.
| Command |
What it does |
agentarivm agent-token install |
Install the Claude credential the agents run on, read from stdin so it never lands in your shell history. --engine codex installs an OpenAI API key instead. |
agentarivm engine-login codex |
Sign the agents into Codex with a ChatGPT subscription — a device code shown in the terminal, entered in any browser. status checks it, logout clears it. |
These are how a running agent reports back from inside its worktree. You will
see them in prompts and logs; there is no reason to type them.
| Command |
What it does |
agentarivm report --stage <stage> [--message "..."] |
Progress. |
agentarivm complete [--message "..."] [--pull-request <url>] |
Done. |
agentarivm fail --message "..." |
Stopped, and why. |
