Skip to main content
CLI/pd swarm
CLI command · v3.30.6

pd swarm

pd swarm is an alias for pd agents. List registered agents.

Syntax

Run pd swarm like this

pd swarm
API spec

Command contract

Canonical command

pd agents

Reference route

/docs/cli/swarm

Reference group

Agents, Actors, Fleets, And Spawn Control

Runtime path

daemon-backed CLI command

Source

cli/commands/agents.ts, cli/commands/actors.ts, cli/commands/spawn.ts, cli/commands/fleet.ts, cli/commands/quorum.ts

Aliases

pd swarm

Output mode

human display plus --json machine output

Page type

generated API spec from the source-backed catalog

See the command surfaces this reference keeps in play

This clip shows the daemon health check, command discovery, and message-loop patterns that recur across the CLI reference. Here it grounds the pd swarm reference: daemon health, discovery, and message-loop patterns these pages keep pointing back to.

Usage patterns

Common ways this command shows up in practice

pd swarm belongs to Agents, Actors, Fleets, And Spawn Control. Launch work, inspect bodies, talk to durable role actors, and run declarative fleets with budget gates.

daemon-backed CLI command. Validate live behavior from the daemon and handler source when changing this command.

Use pd agents in automation when you want the canonical spelling; pd swarm resolves to the same command contract.

Flags

Options that change command behavior

--active

Filter output to currently active records.

--json

Return machine-readable JSON instead of the human display.

Examples

Example 01

Run pd swarm from a coordinated checkout

CLI
pd swarm
Output
Runs the pd swarm command family and prints the resulting Port Daddy state, ids, or readiness/error details.
Example 02

Find this command from the full CLI reference

CLI
pd help agents
open /docs/cli/agents
Output
The help topic and docs route both describe pd agents, including aliases, flags, and source provenance.