Skip to main content
The Locus CLI brings tool discovery, metered calls, and account management to your terminal. Use it interactively or give an agent structured JSON output for scripts and background jobs.

​
Install and sign in

1

Install

Terminal
The installer supports macOS and Linux, verifies the download, and installs a matching agent skill. Add the install directory to your shell profile for new shells. Run the installer again to upgrade.
2

Sign in and check the connection

Terminal
Sign-in verifies your email through Okibi Identity. If that email has no Locus account yet, Locus creates one with an agents workspace and emails you a link to set a password. The CLI works right away. The dashboard asks for that password first, so you can sign in there on your own.The CLI credential expires 7 days after its last use and no later than 30 days after it was issued. Run locus auth login again to issue a fresh one; a repeat sign-in replaces the credential for this installation instead of failing.

​
Find the command you need

Describe the job or browse help:
Find a command
Search enabled tools:
Search tools
The installed skill helps your agent choose commands and flags.

​
Use it from an agent

--agent enables compact JSON output and non-interactive execution.
--agent also confirms writes. Add --dry-run to inspect a change first.
Preview a change
For an unattended enterprise agent, supply a scoped Agent Connection from your secret manager:
Service credential
Keep tenant secret keys out of agent prompts. Reuse the same idempotency key when retrying a paid call or write whose outcome is uncertain.

​
Commands and output

Available commands depend on your account and credential permissions. Use --json for structured output, --csv for tables, or --select id,name,status to choose fields. Each command’s --help lists its options.

​
Troubleshooting

Check authentication and connectivity
These commands inspect authentication and connectivity without exposing the credential. If the default identity flow is unavailable, use locus auth native. The CLI connects to https://api.paywithlocus.com/api by default.

​
Next steps