Skip to main content

Documentation Index

Fetch the complete documentation index at: https://zpg6.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

npm install -g swarmlord
swarmlord help

Auth

swarmlord login                   # browser flow → writes ~/.config/swarmlord/credentials
swarmlord key list
swarmlord key create
swarmlord key revoke <id>

Agent lifecycle

swarmlord init <name>             # scaffold a swarmlord.jsonc
swarmlord deploy                  # validate and deploy

Running

swarmlord run [agent] [-m <message>] [--no-stream] [--json]

swarmlord run -m "Hello"          # uses the swarmlord.jsonc in cwd
swarmlord run my-agent -m "Hi"    # explicit agent
swarmlord run my-agent --no-stream -m "Reply pong"
echo "Hello" | swarmlord run my-agent
FlagEffect
-m/--messageThe prompt. Also accepts stdin or positional.
--no-streamWait for the terminal event, print only the final reply.
--jsonEmit raw AgentEvent JSON lines.
Ctrl-C aborts the session.

Logs

swarmlord logs <session-id>
swarmlord logs <session-id> -f          # follow live
swarmlord logs <session-id> --json

MCPs

swarmlord mcp list                       # installed for your user
swarmlord mcp list --available           # the full registry
swarmlord mcp install sendblue
swarmlord mcp show sendblue              # required secrets, schema

Secrets

swarmlord secret set SENDBLUE_API_KEY_ID
Prompts for the value, stores it encrypted. Grant access in the bundle via secretGrants.

Webhooks

swarmlord webhook add https://example.com/hook --events session.completed
Subscribes your URL to the chosen events. Each delivery is HMAC-signed.

Dynamic commands

Anything under command: in swarmlord.jsonc becomes a subcommand:
"command": {
  "greet": { "template": "Say hello to ${1} in one sentence." }
}
$ swarmlord greet Zach
Hello Zach! Hope you're having a fantastic day.
Templates support ${1}, ${2}, and named flags. The CLI dispatches against the agent in the bundle.

Help

swarmlord help or swarmlord <command> --help for any subcommand.