veg/tmux-party
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: README points at --help and the man page for reference

Browse source 
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).
This commit is contained in:
veg 2026-09-21 09:35:11 +00:00
parent fa36c29584
commit 34a79276ac
1 changed files with 1 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -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 <name>` selects among several hosted parties. |
| `party mute alice` | Demote alice to read-only. `--party <name>` selects among several hosted parties. |
| `party kick alice` | Revoke alice's invite, disconnect her, kill her guest session. `--party <name>` selects among several hosted parties. |
| `party detach alice` | Disconnect alice; keep her on the allowlist. `--party <name>` 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 <name>]` | 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