CLI Reference

Complete reference for the elasticclaw CLI.

All commands support --profile to target a specific ElasticClaw Server,--json for machine-readable output, and --quiet to suppress non-essential output.

Global Flags

--config — CLI profile config path (default ~/.elasticclaw/config.yaml)

--profile — Server profile to use

--json — Output as JSON

--quiet, -q — Suppress non-essential output

--yes, -y — Answer yes to all prompts

elasticclaw upgrade

Upgrade the CLI to the latest GitHub release. Auto-detects platform and replaces the binary atomically.

bash
elasticclaw upgrade

Restarts the ElasticClaw Server systemd service if it is running.

elasticclaw install

Install ElasticClaw Server on a remote server via SSH. Sets up the binary, systemd service, Caddy reverse proxy with TLS, and generates tokens.

bash
elasticclaw install   --server ssh://root@my-server.com   --domain server.mycompany.com

Flags:

  • --server — SSH URI (required)
  • --domain — Domain for TLS (required)
  • --ssh-key — SSH private key path
  • --version — Pin a release version (default: latest)
  • --token — Server user token (default: random)
  • --ui-password — Web UI password (default: random)
  • --skip-caddy — Skip Caddy/TLS setup

elasticclaw hub

ElasticClaw Server management commands.

hub init

Generate a server config file.

bash
elasticclaw hub init
elasticclaw hub init --public-url https://server.example.com
elasticclaw hub init --print  # stdout only, don't write

hub upgrade

Upgrade ElasticClaw Server on a remote server via SSH.

bash
elasticclaw hub upgrade --server ssh://root@server.example.com

hub service

Manage the systemd service (Linux only).

bash
sudo elasticclaw hub service install    # write unit file, enable, start
sudo elasticclaw hub service uninstall  # stop, disable, remove
elasticclaw hub service status

hub caddy

Manage Caddy reverse proxy (Linux only). Handles TLS via Let's Encrypt.

bash
sudo elasticclaw hub caddy install --domain server.example.com
sudo elasticclaw hub caddy uninstall

elasticclaw profile

Manage server connection profiles. Each profile stores a server URL and token.

bash
elasticclaw profile ls
elasticclaw profile create work --url https://server2.example.com --token mytoken
elasticclaw profile use work
elasticclaw profile rename work prod
elasticclaw profile rm work
elasticclaw profile show

elasticclaw create

Legacy template-based agent creation. This command is hidden and deprecated; use elasticclaw workspace push and elasticclaw workflow trigger for workflow-created agents.

elasticclaw chat

Start an interactive chat session with an agent.

bash
elasticclaw chat my-agent

elasticclaw list / ls

List running agents.

bash
elasticclaw list
elasticclaw ls --json

elasticclaw inspect

Show detailed info about an agent.

bash
elasticclaw inspect my-agent

elasticclaw kill

Terminate an agent and destroy its sandbox.

bash
elasticclaw kill my-agent

elasticclaw workspace

Manage workspaces.

bash
elasticclaw workspace create --name my-workspace  # scaffold .elasticclaw/workspaces/my-workspace
elasticclaw workspace list                # list server workspaces
elasticclaw workspace push my-workspace    # push workspace files to server
elasticclaw workspace rm my-workspace      # remove from server
elasticclaw workspace show my-workspace    # show workspace config

elasticclaw workflow

Push, inspect, and manually trigger workflows in a workspace.

bash
elasticclaw workflow push --workspace my-workspace .elasticclaw/workflows
elasticclaw workflow list --workspace my-workspace
elasticclaw workflow show triage --workspace my-workspace
elasticclaw workflow trigger triage --workspace my-workspace --input key=value

elasticclaw secret

Manage workspace-scoped secrets.

bash
elasticclaw secret create openai_api_key --workspace my-workspace --value "$OPENAI_API_KEY"
printf '%s' "$TOKEN" | elasticclaw secret create deploy_token --workspace my-workspace
elasticclaw secret list --workspace my-workspace
elasticclaw secret rm deploy_token --workspace my-workspace

elasticclaw github-app

Manage workspace-scoped GitHub Apps for repository access.

bash
elasticclaw github-app create app-bot --workspace my-workspace \
  --app-id 123456 \
  --url https://github.com/apps/app-bot \
  --installation my-org \
  --private-key-file ./app-bot.private-key.pem
elasticclaw github-app list --workspace my-workspace
elasticclaw github-app rm app-bot --workspace my-workspace

elasticclaw provider

List available sandbox providers.

bash
elasticclaw provider list

elasticclaw login

Authenticate with ElasticClaw Server.

bash
elasticclaw login --hub https://server.example.com --token mytoken

elasticclaw hub

Start ElasticClaw Server, including the embedded web UI.

bash
elasticclaw hub