Skip to content

CLI reference

All commands. Grouped by area. Run agentx <command> --help for the canonical flags.

Quick orientation

bash
agentx --version
agentx --help
agentx <command> --help

The CLI binary is agentx. The npm package is agentix-cli.

Init

CommandDescription
agentx initCreate agentx.json, .env, runtime dirs in current directory

Daemon

CommandDescription
agentx daemon start [-c <config>] [-d/--detach] [--port <n>]Start the daemon
agentx daemon stopStop the running daemon
agentx daemon status [--json]Show daemon PID, agents, channels, crons, mesh peers
agentx daemon logs [-n <lines>] [-f]Tail daemon logs
agentx daemon watchLive, color-coded SSE activity feed
agentx daemon send <agent> <message> [--peer <name>] [--json]Send a task to an agent (local or mesh peer)
agentx daemon deploy <host> [-i <key>] [-u <user>] [-p <path>] [--restart] [--skip-checks]Rsync deploy to a remote host

Agents

CommandDescription
agentx agent list (alias ls)List configured agents with workspace and mentions
agentx agent addAdd an agent interactively
agentx agent remove <id> (alias rm)Remove agent from config (workspace is preserved)

Channels

CommandDescription
agentx channel list (alias ls)List channels + agent bindings
agentx channel addAdd a channel interactively (Telegram / WhatsApp / Discord / GitLab)

Crons

CommandDescription
agentx cron list (alias ls)List cron jobs (schedule, agent, status)
agentx cron addAdd a cron interactively
agentx cron enable <id>Enable a cron job
agentx cron disable <id>Disable a cron job

Notes on onError: either a string or an array — ["log"], ["notify"], ["disable"], or any combination. See Journey 2.

Mesh (A2A)

CommandDescription
agentx mesh list (alias ls)List peers + health status
agentx mesh addAdd a peer interactively (name, URL, token)
agentx mesh remove <name> (alias rm)Remove a peer

Wiki

CommandDescription
agentx wiki status [--mode <unified|graph|flat>]Status per agent (entries, articles, unabsorbed)
agentx wiki entries [--agent <id>]List raw entries
agentx wiki absorb [--agent <id>] [--mode <m>] [--max <n>] [--dry-run]Compile raw entries into articles
agentx wiki lint [--agent <id>]Check wiki for broken links, orphans
agentx wiki search <query> [--agent <id>]Search articles
agentx wiki serve [--port <n>] [--peer <url>...]Wikipedia-style web browser (local + mesh peers)
agentx wiki sync [--peer <url>] [--dry-run]Pull raw entries from mesh peers
agentx wiki compare --agent <id>Deterministic side-by-side comparison of all three modes

Skills

CommandDescription
agentx skill list (alias ls)List skills per agent
agentx skill add <skillPath> [--agent <id>] [--all]Add a skill to one or all agents

Hooks

CommandDescription
agentx hook add <agent>Add a hook interactively (event, type, matcher regex)

Supported events (PreToolUse, PostToolUse, SessionStart, Notification, Stop); types: command, http.

Usage & tokens

CommandDescription
agentx usage todayToken usage summary — last 7 days, per agent
agentx usage serve [--port <n>]Web dashboard
agentx usage report [--days <n>]Full session analysis across Claude Code JSONL

Config

CommandDescription
agentx config checkValidate agentx.json + workspaces
agentx config showPrint the resolved configuration (env expanded)

Migration

CommandDescription
agentx migrate openclaw [<configPath>] [--dry-run]Import agents, channels, crons, Telegram accounts from an OpenClaw config

See Migrate from OpenClaw.

Environment variables

VariablePurpose
AGENTX_DEBUGComma-separated categories: webhook, agent, channel, cron, mesh, context, memory, config, all
MESH_TOKENShared secret between mesh peers
TG_*_BOT_TOKENConvention for Telegram bot tokens (${TG_FOO_BOT_TOKEN} in agentx.json)

HTTP endpoints

Summary — full schemas in Communication matrix.

MethodPathPurpose
POST/taskH2A: send a task to a local agent
POST/sendA2H initiate / cross-channel outbound
POST/mesh/taskCross-mesh delegation
POST/askShort-form voice/Siri endpoint
POST/webhook/:agentId[/:source]Generic webhook receiver
GET/eventsSSE event stream
GET/healthHealth check
GET/.well-known/agent-card.jsonAgent card for mesh peers
GET/wiki/agents, /wiki/entries, /wiki/articles, /wiki/articleWiki read API
POST/debug/on?categories=..., /debug/offToggle debug categories at runtime
GET/business/work/list?agent=<id>, POST /business/work/claim, POST /business/work/report, POST /business/clock-out, GET /business/kpi/today, GET /business/kpi/weekBusiness layer API

Released under the MIT License.