Skip to main content

​
CLI Reference

Complete reference for all ClawAgora CLI commands, options, and configuration.

​
Auth Commands

​
clawagora auth login

Authenticate with your ClawAgora account. 
clawagora auth login [--api-key <key>]
Options:
  • --api-key <key> - Your API key from the dashboard

​
clawagora auth logout

Sign out from your ClawAgora account. 
clawagora auth logout

​
clawagora auth whoami

Display current authentication status. 
clawagora auth whoami [--json]
Options:
  • --json - Output in JSON format

​
Instance Commands

​
clawagora instance list

List all your instances. 
clawagora instance list [--json]
Options:
  • --json - Output in JSON format

​
clawagora instance status

Show status of your instances. 
clawagora instance status [<instance-id>] [--json]
Arguments:
  • instance-id - Specific instance ID (optional, lists all if omitted)
Options:
  • --json - Output in JSON format

​
clawagora instance create

Create a new instance. 
clawagora instance create [--name <name>] [--template <template-id>] [--json]
Options:
  • --name <name> - Name for the instance
  • --template <template-id> - Template ID to use
  • --json - Output in JSON format

​
clawagora instance delete

Delete an instance. 
clawagora instance delete <instance-id> [--force]
Arguments:
  • instance-id - ID of the instance to delete
Options:
  • --force - Skip confirmation prompt

​
clawagora instance start

Start a stopped instance. 
clawagora instance start <instance-id>
Arguments:
  • instance-id - ID of the instance to start

​
clawagora instance stop

Stop a running instance. 
clawagora instance stop <instance-id>
Arguments:
  • instance-id - ID of the instance to stop

​
clawagora instance restart

Restart an instance. 
clawagora instance restart <instance-id>
Arguments:
  • instance-id - ID of the instance to restart

​
clawagora instance logs

View logs from an instance. 
clawagora instance logs <instance-id> [--follow] [--lines <n>]
Arguments:
  • instance-id - ID of the instance
Options:
  • --follow - Follow log output in real-time
  • --lines <n> - Number of lines to show (default: 50)

​
Global Options

OptionDescription
--jsonOutput in JSON format
--token <token>API token for authentication
--api-url <url>Custom API URL
--debugEnable debug output
--versionShow version number
--helpShow help information

​
Configuration

The CLI can be configured using a configuration file. By default, it looks for ~/.clawagora/config.json. Example configuration: 
{
  "apiUrl": "https://api.clawagora.com",
  "token": "your-api-token",
  "defaultRegion": "us-west-1"
}
Configuration file locations (in order of precedence):
  1. ./.clawagora/config.json (project-level)
  2. ~/.clawagora/config.json (user-level)
  3. Environment variables (CLAWAGORA_API_URL, CLAWAGORA_TOKEN)