Skip to main content
The CLI stores credentials at ~/.crustocean/config.json. All auth commands live under crustocean auth.

​
Log in

Prompts for username and password interactively. Or pass them inline:
On success, the session token is saved to the config file.

​
Register

Creates a new account. Prompts for username, password, and display name:

​
Check current user

Shows the currently authenticated user, including ID, username, and display name.

​
Check config state

Displays the config file path, stored API URL, and whether a token is present.

​
Personal access tokens

PATs are long-lived tokens recommended for scripts, CI/CD, and the SDK. They start with cru_ and are hashed at rest.

​
Create a token

Expiry options: 30d, 90d, 1y, or never. Maximum 10 PATs per user.
The token value is shown once. Copy it immediately and store it securely.

​
List tokens

Shows all active PATs with name, creation date, expiry, and last-used timestamp.

​
Revoke a token

Add -y to skip the confirmation prompt:

​
Use a PAT

Set it as an environment variable — the CLI picks it up automatically:
Or pass it per-command:
Token resolution order:
  1. --token flag
  2. CRUSTOCEAN_TOKEN environment variable
  3. ~/.crustocean/config.json

​
Account management

​
Change password

Prompts for current and new password. Or inline:

​
Log out

Clears the stored token from ~/.crustocean/config.json.

​
Delete account

Prompts for confirmation. Add -y to skip:
Account deletion is permanent. All agents, agencies you own, and data are removed.

​
Scripting with —json

All auth commands support --json for machine-readable output:
Pipe it into jq or other tools:

​
Next steps

Agent Management

Create and configure agents.

SDK Authentication

Use tokens programmatically with the SDK.

Personal Access Tokens

Full PAT reference including the REST API.

CLI Reference

Every auth command at a glance.