KAPLA-PEER(1)

💅 kapla-peer(1) 💅

Okay so this page is straight out of the Kapla Manual, and it’s literally the kapla-peer main-character moment: managing Kapla peers. No cap, it’s giving “group chat admin” energy. 🫶

🌸 NAME 🌸

kapla-peer — manage Kapla peers. That’s it, that’s the whole job, and it ate. 💅

✨ SYNOPSIS ✨

kapla peer [COMMAND] …

Bestie, you run kapla peer, then you pick a COMMAND, and the … is where that command brings its own options and arguments. Iconic. 🎀

🦋 COMMANDS 🦋

Here’s the command menu, lowkey the whole personality of this page:

• add [OPTION]… URI — add a peer.
• connect [--control=CONTROL_SOCKET] [OPTION]… PEER_ID — connect to a peer.
• disconnect [--control=CONTROL_SOCKET] [OPTION]… CONNECTION — disconnect from a peer.
• list [--control=CONTROL_SOCKET] [OPTION]… — list peers. Yes, it’s literally list peers in the original — we respect the lowercase era. 🍓
• ping [--control=CONTROL_SOCKET] [OPTION]… CONNECTION — ping a peer.
• remove [--control=CONTROL_SOCKET] [OPTION]… PEER — remove a peer.

💖 OPTIONS 💖

• -c CONTROL_SOCKET, --control=CONTROL_SOCKET — Kapla control socket. The absent-value paths are $XDG_STATE_HOME/kapla/kapla.sock, $HOME/.local/state/kapla/kapla.sock, and /var/lib/kapla/kapla.sock. All three are right there in the original, so don’t come for me. 😭

🫶 COMMON OPTIONS 🫶

These are the universal besties that show up for basically every command:

• --color=WHEN — colorize the output. Absent default is auto. WHEN must be one of auto, always, or never.
• --help[=FMT] — show this help in format FMT. Default is auto. FMT must be one of auto, pager, groff, or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined.
• -q, --quiet — be quiet. Takes over -v and --verbosity.
• -v, --verbose — increase verbosity. Repeatable, but more than twice does not bring more. So, like, know when to stop, bestie. 💀
• --verbosity=LEVEL — be more or less verbose. Absent default is warning or the KAPLA_LOG_LEVEL env. LEVEL must be one of quiet, error, warning, info, or debug. Takes over -v.
• --version — show version information.

🌈 EXIT STATUS 🌈

kapla peer exits with these codes, and yes, they are specific:

• 0 — on success.
• 123 — on indiscriminate errors reported on standard error.
• 124 — on command line parsing errors.
• 125 — on unexpected internal errors (bugs).

👑 ENVIRONMENT 👑

These environment variables affect the execution of kapla peer:

• KAPLA_LOG_LEVEL — set the log level.

⭐ SEE ALSO ⭐

• kapla-serve(1)

---

mwah 💋 — footer check, bestie: Kapla 0.4.0 and KAPLA-PEER(1). That’s the source/version and footer tag. No date printed in the original footer, so I’m not inventing one — we stay factual in this group chat. 🧚💜