From 34a79276ac4d696db6348c2845e6eb698ee082a1 Mon Sep 17 00:00:00 2001 From: veg Date: Mon, 21 Sep 2026 09:35:11 +0000 Subject: [PATCH] docs: README points at --help and the man page for reference The subcommand table was a third copy of usage() and party.1 and had drifted from both (no --group, no rw/ro aliases, no --version). --- README.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/README.md b/README.md index 7997d26..d3d9625 100644 --- a/README.md +++ b/README.md @@ -108,25 +108,7 @@ The honest caveats, with the full detail in `man party`: ## Reference -| Subcommand | Effect | -|---|---| -| `party host [name]` | Spawn a dedicated party tmux server. Only the host is on the allowlist. Names: letters, digits, `_`, `-`; max 63 chars. | -| `party invite alice [-r]` | Add alice to the allowlist. `-r` / `--read-only` invites as a watcher. | -| `party voice alice` | Promote alice to read/write. `--party ` selects among several hosted parties. | -| `party mute alice` | Demote alice to read-only. `--party ` selects among several hosted parties. | -| `party kick alice` | Revoke alice's invite, disconnect her, kill her guest session. `--party ` selects among several hosted parties. | -| `party detach alice` | Disconnect alice; keep her on the allowlist. `--party ` selects among several hosted parties. | -| `party list` | List live parties on this host. | -| `party who [--short]` | Show invited and attached users for the current party. | -| `party status` | Show the caller's own state: hosting, attached, or idle. | -| `party close` | Tear down the party server and its roster entry. Host-only. | -| `party clean` | Remove the caller's own dead party dirs: crash leftovers whose tmux server is gone. Rescues a non-empty transcript first. | -| `party log [--stop] [--party ]` | Record the party into its private dir via `tmux pipe-pane` (host only), group-readable. `--stop` ends it. | -| `party join [name] [--passive]` | Join a party. Auto-attaches when one is running; picker otherwise. `--passive` attaches read-only to the host's view (watcher mode). Read-only invitees always join passive. | -| `party leave` | Detach and clean up the per-guest session. | -| `party knock [name]` | Ask the host of an invite-only party for an invite (write(1) ping with the exact invite command). | -| `party role [active\|passive\|switch]` | Flip your clients between guest and host session. No arg prints the current role. | -| `party --help` | Help text. | +`party --help` lists every subcommand, each subcommand takes `--help`, and `man party` is the full reference. ## Credits