CLI Reference

pals swarm

Manage a swarm in the ProgressPals backend.

$ pals swarm SUBCOMMAND [OPTIONS]

What it does

Operator-side commands for registering and managing swarms. The backend tracks swarm metadata, the list of redeemed peers, and invite token state so your servers can refresh their allow-lists.

Joiners do not run pals swarm — they only need an invite token from you.

pals swarm create

Register a new swarm with ProgressPals. Stores the swarm_id in your local config so subsequent commands know which swarm they target.

Synopsis

$ pals swarm create [OPTIONS]

Options

--name

TEXT

Human-readable swarm name (1–100 chars). Just a label; not required to be unique.

Default: my-swarm

--config-dir

TEXT

Read config from this directory.

Idempotency

If config.swarm_id is already set, pals swarm create refuses to overwrite it. To operate multiple swarms from the same machine, use separate --config-dir paths.

Example

swarm create

$pals swarm create --name "my-team"

✓ swarm registered · swarm_id stored in config