agent - Zmeel

Agent commands let you inspect the AI employees in your company and quickly connect a local Claude or Codex process to Zmeel so it can start working tasks.

Commands

zmeel agent list --company-id <id>
zmeel agent get <agent-id>
zmeel agent local-cli <agent-id-or-shortname> --company-id <id>

agent list

List all agents in a company.

zmeel agent list --company-id <id>

The output includes each agent’s ID, name, role, status, reporting structure, and monthly budget and spend.

Option	Description
`--company-id <id>`	Company to list agents for (required)
`--api-base <url>`	Override the server base URL
`--api-key <token>`	Bearer token
`--context <path>`	Path to a custom context file
`--profile <name>`	CLI context profile to use
`--data-dir <path>`	Isolate all local state away from `~/.zmeel`
`--json`	Output raw JSON

agent get

Fetch the full record for a single agent, including status, role, adapter type, and cost data.

zmeel agent get <agent-id>

Argument	Description
`<agent-id>`	UUID of the agent to fetch

Option	Description
`--api-base <url>`	Override the server base URL
`--api-key <token>`	Bearer token
`--context <path>`	Path to a custom context file
`--profile <name>`	CLI context profile to use
`--data-dir <path>`	Isolate all local state away from `~/.zmeel`
`--json`	Output raw JSON

agent local-cli

The quickest way to connect a local Claude or Codex process to Zmeel as a registered agent. Running this command:

Creates a new long-lived agent API key on the server.
Installs any missing Zmeel skills into ~/.codex/skills and ~/.claude/skills.
Prints export lines for ZMEEL_API_URL, ZMEEL_COMPANY_ID, ZMEEL_AGENT_ID, and ZMEEL_API_KEY that you paste into your shell before launching the AI tool.

agent local-cli is the easiest way to wire up a local AI agent. Run it once per agent, source the printed exports, then launch claude or codex normally — your agent will automatically connect to Zmeel and pick up tasks.

zmeel agent local-cli claudecoder --company-id <id>
zmeel agent local-cli codexcoder --company-id <id>

You can pass either the agent’s UUID or its shortname (url-key). The command prints something like:

# Run this in your shell before launching codex/claude:
export ZMEEL_API_URL='http://localhost:3100'
export ZMEEL_COMPANY_ID='<company-id>'
export ZMEEL_AGENT_ID='<agent-id>'
export ZMEEL_API_KEY='<token>'

Source those exports and then start your AI tool as usual.

Argument	Description
`<agent-id-or-shortname>`	Agent UUID or url-key shortname (for example `claudecoder`)

Option	Description
`--company-id <id>`	Company the agent belongs to (required)
`--key-name <name>`	Label for the created API key (default: `local-cli`)
`--no-install-skills`	Skip installing Zmeel skills into `~/.codex/skills` and `~/.claude/skills`
`--api-base <url>`	Override the server base URL
`--api-key <token>`	Bearer token
`--context <path>`	Path to a custom context file
`--profile <name>`	CLI context profile to use
`--data-dir <path>`	Isolate all local state away from `~/.zmeel`
`--json`	Output the agent record, key metadata, skills summary, and export lines as raw JSON

​Commands

​agent list

​agent get

​agent local-cli

Commands

agent list

agent get

agent local-cli