Skip to content

Orchestrator Commands (Beta)

This page documents orchestration-related CLI commands.

Environment Variables

  • HOARD_SERVER_SECRET is required to start the write-enabled server.
  • HOARD_TOKEN is required for most CLI calls (scoped token).
  • HOARD_REGISTRATION_TOKEN is required for hoard agent register if not stored in config.

hoard orchestrate init

Initialize orchestration settings and generate a registration token.

Terminal window
hoard orchestrate init

Prompts for artifact storage path and retention days.

hoard agent

Register and manage agents.

Terminal window
hoard agent register <name> --type worker --scopes search,get,task.claim --capabilities summarize
hoard agent list
hoard agent deregister <agent_id>

Options:

  • --type defaults to worker
  • --scopes comma-separated list
  • --capabilities comma-separated list

hoard task

Create and manage tasks.

Terminal window
hoard task create "Write summary" --description "Summarize docs" --capability summarize --priority 3
hoard task list --status queued
hoard task poll --limit 5
hoard task claim tsk-1234
hoard task complete tsk-1234 --summary "Summary complete"

hoard artifact

Attach and retrieve artifacts for tasks.

Terminal window
hoard artifact put tsk-1234 output.md --type text --content "Hello"
hoard artifact get art-1234 --include-content
hoard artifact list --task tsk-1234
hoard artifact list --workflow wf-1234

hoard event

Publish and poll orchestration events.

Terminal window
hoard event publish task.note --payload '{"message": "hello"}'
hoard event poll --limit 50

hoard cost

Read cost summaries and budgets.

Terminal window
hoard cost summary --period today
hoard cost budget --agent <agent_id> --period today
hoard cost budget --workflow wf-1234 --period today

hoard workflow

Create and manage workflows.

Terminal window
hoard workflow list --status running
hoard workflow create "Demo" --definition workflow.json
hoard workflow start wf-1234
hoard workflow status wf-1234

MCP-Only Tools

These tools exist in MCP but are not exposed via CLI yet:

  • task.start, task.fail, task.cancel, task.delegate, task.get
  • workflow.pause, workflow.resume, workflow.cancel, workflow.get
  • cost.report

Use the MCP endpoint if you need these.