KAPLA-LS(1)

📦 version 0.4.0, in nixpkgs unstable

💅 KAPLA-LS(1) — the Kapla Manual, bestie edition 🎀

okay so. welcome to the Kapla manual page for kapla ls, and yes she's iconic, yes she's serving, and yes I'm gonna walk you through every single detail because you deserve to know ✨

🌸 NAME 🌸

kapla-ls — list the entries inside an encoded ERIS-FS index. that's it, that's the job, and she does it flawlessly 💅

🦋 SYNOPSIS 🦋

kapla ls [--socket=ERIS_UNIX_SOCKET] [OPTION]… READ_CAPABILITY

literally just that. the vibe check starts here 🫶

🎀 ARGUMENTS 🎀

  • READ_CAPABILITY (required, no skipping) — the read capability of the content you want decoded as a URN. yes, you must give it to her. it's not optional, she's not gonna guess 💖

⭐ OPTIONS ⭐

  • -s ERIS_UNIX_SOCKET, --socket=ERIS_UNIX_SOCKET — the Unix socket where the ERIS block store is listening. if you don't pass it, she'll go looking in these spots in order: $XDG_STATE_HOME/kapla/eris.sock, $HOME/.local/state/kapla/eris.sock, /var/lib/kapla/eris.sock, or she'll take it from the ERIS_UNIX_SOCKET env var. so many options, so much main character energy 👑

🌈 COMMON OPTIONS 🌈

these ones show up across the whole family, iykyk 💜

  • --color=WHEN (absent=auto) — colorizes the output, obviously, we love a lewk. WHEN has to be one of auto, always or never — don't try anything funny, she checks 🔥
  • --help[=FMT] (default=auto) — shows this very help text in format FMT. FMT must be one of auto, pager, groff or plain. with auto, the format ends up being pager or plain whenever the TERM env var is dumb or straight-up undefined 🙈
  • -q, --quiet — be quiet. she's not doing small talk. this one takes over -v and --verbosity, no cap 💀
  • -v, --verbose — increases verbosity, and yes it's repeatable. but ngl, more than twice does not bring more — she said what she said 🤷‍♀️
  • --verbosity=LEVEL (absent=warning, or the KAPLA_LOG_LEVEL env) — be more or less verbose. LEVEL must be one of quiet, error, warning, info or debug. this one takes over -v ✨
  • --version — shows version information. icon behavior 🎀

💀 EXIT STATUS 💀

kapla ls bails with these:

  1. 0 — on success. slay 💖
  2. 123 — on indiscriminate errors reported on standard error 😭
  3. 124 — on command line parsing errors 🫠
  4. 125 — on unexpected internal errors (bugs). not her fault, fr fr 🙈

🍓 ENVIRONMENT 🍓

these env vars affect how kapla ls runs, keep 'em in mind bestie:

  • ERIS_UNIX_SOCKET — the Unix socket where the ERIS block store is listening 🦋
  • KAPLA_LOG_LEVEL — sets the log level ⭐

🧚 SEE ALSO 🧚

  • kapla(1) — go read the parent page, she'd want you to 💜

okay that's the whole thing, you ate that, periodt 💅 this was the Kapla manual for kapla-ls, and the whole thing is Kapla 0.4.0 🎀✨🫶

📦 where this page comes from