CLI reference
Every officeclaws command and flag in one place.
Run officeclaws help for the built-in summary. Most commands that act on an agent accept --agent <id>. Without it, they use your first agent.
Account
| Command | Description |
|---|---|
officeclaws register [--email] [--name] [--password-stdin] | Create an account and log in |
officeclaws login [--email] [--password-stdin] | Log in |
officeclaws logout [--keep-credentials] | Log out. Also deletes saved credentials unless you pass --keep-credentials. |
officeclaws whoami | Show the current account and whether it has an agent |
officeclaws subscribe [--plan selfHosted] [--locale en] | Open the checkout linked to your account |
--password-stdin reads the password from standard input, for scripts. Example: echo "$PW" | officeclaws login --email [email protected] --password-stdin.
Agents
| Command | Description |
|---|---|
officeclaws onboard [flags] | Set up a Contabo VPS as an agent. See Create your agent. |
officeclaws agents | List your agents |
officeclaws connect-codex [--agent] | Connect your ChatGPT subscription |
officeclaws chat [--agent] [-m "message"] | Chat interactively, or send a single message |
officeclaws logs [--agent] [--lines N] [-f] | Show or stream the agent's logs |
onboard flags: --name, --vps, --reinstall, --ssh-pubkey, --avatar, --comm-style, --tailscale-hostname, --tailscale-authkey, --contabo-client-id, --contabo-client-secret, --contabo-api-user, --contabo-api-password. --reinstall is meant for our internal prebuilt server images and doesn't wipe your VPS. To start from a clean server, reinstall Ubuntu 24.04 from the Contabo control panel instead.
Scheduled tasks
| Command | Description |
|---|---|
officeclaws cron list | List scheduled tasks |
officeclaws cron add --name --schedule --message [--timezone] [--channel] [--target] | Add a task |
officeclaws cron rm <name-or-id> | Remove a task |
Telegram
| Command | Description |
|---|---|
officeclaws telegram set [--bot-token] [--dm-policy pairing|allowlist|open|disabled] | Connect or update the bot |
officeclaws telegram show | Show the current settings |
officeclaws telegram pairings | List pending pairing codes |
officeclaws telegram approve <code> | Approve a Telegram user |
officeclaws telegram disable | Turn Telegram off |
Credentials and devices
| Command | Description |
|---|---|
officeclaws vault list [--type contabo|tailscale|telegram] | List saved credentials (values masked) |
officeclaws vault apply <id> | Make a saved set the active one |
officeclaws vault rm <id> | Delete a saved set |
officeclaws devices list / approve <id> | Device requests on the agent's gateway |
officeclaws pairing list / approve <id> / reject <id> / repair | Operator pairing requests; repair fixes "1008 pairing required" |
Advanced
| Command | Description |
|---|---|
officeclaws adopt --vps <id> --host <tailscale-ip> --name <name> | Register an agent that's already running when setup got interrupted after the server was ready. Use it only if support asks you to. |
officeclaws version | Print the version |
Environment variables
| Variable | Description |
|---|---|
OFFICECLAWS_DEBUG=1 | Print detailed logs to stderr |
OPENCLAW_RPC=0 | Use the fallback chat connection (rarely needed) |
Where things are stored
| What | Where |
|---|---|
| Session, Contabo and Tailscale credentials, vault | System keychain, service openclaw-office |
| SSH key used to manage your agents | ~/.ssh/openclaw_id_ed25519 |
| Setup logs | ~/.openclaw/logs |