Documentation menu
CLI Reference

pals peers

List / revoke peers that have joined your swarm.

$ pals peers SUBCOMMAND [OPTIONS] [ARGS]

Overview

Three subcommands manage swarm membership:

  • list — see redeemed peers (active + revoked).
  • revoke — remove a peer from the allow-list.
  • kick — alias of revoke.

pals peers list

Synopsis

$ pals peers list [OPTIONS]

Options

--json
Emit a JSON array instead of the table. Never includes the swarm secret or per-peer credential.
--include-revoked / --no-include-revoked
Whether to include revoked peers. Default: include (so you see the full history).
Default: include-revoked
--config-dir
TEXT
Read config from this directory.

Example

peers list
$pals peers list
PEER ID JOINED STATUS INVITE
12D3Koo...abc 2025-05-18 10:01 active pp_inv_a8…
12D3Koo...def 2025-05-17 22:14 revoked pp_inv_a8…

pals peers revoke / pals peers kick

Two names for the same operation. The chosen peer is removed from the allow-list and stops being accepted at the next server poll (~30 seconds).

Synopsis

$ pals peers revoke PEER_ID [OPTIONS]
$ pals peers kick PEER_ID [OPTIONS]

Arguments

peer_id
TEXTrequired
Full base58 peer ID. Use pals peers list or pals dash to find it.
The libp2p allow-list is the enforcement boundary. The kicked peer’s local swarm secret is not invalidated by the kick — the secret only matters if the allow-list boundary is bypassed.