KAPLA-PEER-LIST(1)

💅 kapla-peer-list(1) — the Kapla Manual, bestie edition

okay so picture this: it's giving manual page, it's giving iconic, and it's literally called kapla-peer-list 💖. That's the kapla peer list command, and its whole entire job? Listing peers. That's it. That's the vibe. She's a simple girl and she slays at it. ✨

---

🌸 SYNOPSIS 🌸

kapla peer list [--control=CONTROL_SOCKET] [OPTION]…

like, you run kapla peer list, you optionally point her at a control socket with --control=CONTROL_SOCKET, you toss in whatever [OPTION]… you want, and she goes. periodt. 🫶

---

🎀 OPTIONS 🎀

• -c CONTROL_SOCKET, --control=CONTROL_SOCKET — the Kapla control socket. you can leave it out (absent) and she'll go looking in this order, no cap:
  • $XDG_STATE_HOME/kapla/kapla.sock
  • $HOME/.local/state/kapla/kapla.sock
  • /var/lib/kapla/kapla.sock

she literally checks those three, in that order, and picks the first one that hits. the way that's so organized of her 💅

---

✨ COMMON OPTIONS ✨

these are the options everyone gets, not just peer list. shared queen behavior 👑

• --color=WHEN (absent=auto) — colorize the output, bestie. 🌈 WHEN has to be exactly one of auto, always or never — those three, nothing else, iykyk.
• --help[=FMT] (default=auto) — shows this help in format FMT. FMT must be one of auto, pager, groff or plain. and when it's auto? the format is pager or plain whenever the TERM env var is dumb or undefined. not me knowing that by heart 😭
• -q, --quiet — be quiet. 🤫 and she's assertive about it: this takes over -v and --verbosity. she wins the argument, fr fr.
• -v, --verbose — increase verbosity. repeatable! but more than twice does not bring more. so like… two is the max useful, don't overdo it 💀
• --verbosity=LEVEL (absent=warning or KAPLA_LOG_LEVEL env) — be more or less verbose. LEVEL must be one of quiet, error, warning, info or debug. and yeah, this one takes over -v. main character energy, honestly. 👑
• --version — show version information. classic. love her. ⭐

---

💜 EXIT STATUS 💜

kapla peer list exits with:

1. 0 — on success. 🎉 slay, we ate, no notes.
2. 123 — on indiscriminate errors reported on standard error. 😭
3. 124 — on command line parsing errors. 🙈 like when you typo a flag, we've all been there.
4. 125 — on unexpected internal errors (bugs). 💀 lowkey not her fault, please file it.

⚠️ heads up: 125 is the bugs one. if you see it, something went sideways internally — it's not a you problem.

---

🦋 ENVIRONMENT 🦋

these environment variables affect the execution of kapla peer list:

• KAPLA_LOG_LEVEL — set the log level. 🌟 that's the one. that's the whole list. she's low maintenance.

---

🍓 SEE ALSO 🍓

• kapla(1) — the big one, the parent, the icon 🌈

---

cute little sign-off: this absolutely stunning piece of documentation is from Kapla 0.4.0, and it lives in the Kapla Manual — KAPLA-PEER-LIST(1), right here in the terminal, bestie. 🧚✨💖 go list some peers, you got this 🫶