CLI Reference

pals invite

Create / list / revoke / resend invite tokens for your swarm.

$ pals invite SUBCOMMAND [OPTIONS] [ARGS]

Overview

Four subcommands cover the invite lifecycle:

create — mint a fresh token.
list — see active and historical invites.
revoke — mark an invite unusable.
resend — re-display the full text of an existing token.

pals invite create

Generates an invite token and displays it once. Save the token immediately and hand it to your invitee through a secure channel.

Synopsis

$ pals invite create [OPTIONS]

Options

--max-uses

INTEGER

How many peers can redeem this token. Range 1–10000.

Default: 1

--expires-hours

FLOAT

Hours until the token expires. Omit for never expires.

--note

TEXT

Optional label so you can later identify this invite (max 500 chars).

--config-dir

TEXT

Read config from this directory.

Example

invite create

$pals invite create --max-uses 5 --expires-hours 24

⟶ Invite token (shown once — save it now):

pp_inv_a8c4f2e9b1d6a7c3...

pals invite list

Shows active and historical invites. Tokens in the table are truncated (first 12 chars + ellipsis) to reduce shoulder-surfing and accidental log capture.

Synopsis

$ pals invite list [OPTIONS]

Options

--json

Emit a JSON array instead of the table. Tokens are still truncated — use pals invite resend to recover the full token.

--status

TEXT

Filter by status. One of active, revoked, expired, spent.

--config-dir

TEXT

Read config from this directory.

pals invite revoke

Marks an invite as revoked. Already-redeemed peers stay in the allow-list — use pals peers revoke to remove a specific peer.

Synopsis

$ pals invite revoke TOKEN_PREFIX [OPTIONS]

Arguments

token_prefix

TEXTrequired

The first ≥8 characters of the token. Use pals invite list to find prefixes.

pals invite resend

Re-displays the full text of an existing invite. Useful when an invitee lost the original message and you don’t want to mint a new invite (which would consume --max-uses capacity if reused as a workaround).

Synopsis

$ pals invite resend TOKEN_PREFIX [OPTIONS]

Options

--yes, -y

Skip the interactive confirmation. Useful in scripts; the security warning still prints.

--config-dir

TEXT

Read config from this directory.

pals invite resend echoes the full token to stdout. Confirm before running it in a shared terminal, and prefer a private session.