Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.circuit.org/llms.txt

Use this file to discover all available pages before exploring further.

​
Sign In

Authenticate with Circuit. 
circuit login
Opens a browser to authenticate. If you don’t have an account, one will be created. How it works:
  1. The CLI generates a unique auth ID via the Circuit API
  2. Opens your browser to the Circuit login page with the auth ID
  3. The CLI polls the API for the session token while you authenticate
  4. Once authenticated, the token is stored in ~/.config/circuit/auth.toml under the [<env>] section matching CIRCUIT_ENV
The login flow has a 300-second timeout. If authentication is not completed in time, the CLI exits. Stored credentials: 
[production]
token = "..."

[staging]
token = "..."

​
Sign Out

Sign out from Circuit. 
circuit logout
Behavior:
  • Removes the [<env>] section from ~/.config/circuit/auth.toml (only the env matching CIRCUIT_ENV; other envs stay logged in). Deletes the file entirely if no envs remain.
  • No parameters required

​
Logged In User Info

Show current authenticated user. 
circuit whoami
Flags:
  • --show-auth / -a: Display the raw auth token for CI/CD use.
Output:
  • Displays your Circuit username
  • Shows authentication status
  • With --show-auth: the token replaces the username on stdout so TOKEN=$(circuit whoami --show-auth) captures it directly. Username/version/api drop to stderr. Use --format json to get both via .token and .username.