KAPLA-DECODE(1)

📦 version 0.4.0, in nixpkgs unstable

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

okay so real talk: this is the kapla-decode page from the Kapla Manual, and we're about to decode some content together. stay with me, it's literally so straightforward. 🦋

✨ NAME ✨

kapla-decode — decode content. that's it. that's the vibe. 🫶

🌸 SYNOPSIS 🌸

kapla decode [--output=OUTPUT] [--socket=ERIS_UNIX_SOCKET] [OPTION]… READ_CAPABILITY

so you're decoding content and you've got yourself a read capability — iconic. 💅

the blocks get pulled from a store, and you reach that store by connecting through a Unix socket. no socket, no blocks, no content. periodt. 🔥

🎀 ARGUMENTS 🎀

  • READ_CAPABILITY (required) — the read capability of the content you wanna decode, expressed as a URN. yes bestie, it's required, don't come to the function without it. 🙈

⭐ OPTIONS ⭐

  • -o OUTPUT, --output=OUTPUT (absent=-) — OUTPUT is the file containing the content to encode. use - for stdin. (yes, the manpage really does say "to encode" here — i'm just the messenger, copying it exactly, no editing over here 💀)
  • -s ERIS_UNIX_SOCKET, --socket=ERIS_UNIX_SOCKET (absent=$XDG_STATE_HOME/kapla/eris.sock, $HOME/.local/state/kapla/eris.sock, /var/lib/kapla/eris.sock or the ERIS_UNIX_SOCKET env) — the Unix socket where the ERIS block store is listening. default hunt order goes $XDG_STATE_HOME/kapla/eris.sock, then $HOME/.local/state/kapla/eris.sock, then /var/lib/kapla/eris.sock, or just use the ERIS_UNIX_SOCKET env var if you're fancy. ✨

🌈 COMMON OPTIONS 🌈

  • --color=WHEN (absent=auto) — colorize the output, bestie. WHEN must be one of auto, always or never. pick your fighter. 🎨
  • --help[=FMT] (default=auto) — show this help 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 undefined. iykyk. 📖
  • -q, --quiet — be quiet. takes over -v and --verbosity. shhhh. 🤫
  • -v, --verbose — increase verbosity. repeatable, but more than twice does not bring more. so like, -vv is the ceiling, girlies. 🔥
  • --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. takes over -v. 👑
  • --version — show version information. slay. 💖

💀 EXIT STATUS 💀

kapla decode exits with:

  1. 0 — on success. we love a win. 🎉
  2. 123 — on indiscriminate errors reported on standard error. 😭
  3. 124 — on command line parsing errors. you typed something cursed. 🙈
  4. 125 — on unexpected internal errors (bugs). not me filing a bug report… 💅

🧚 ENVIRONMENT 🧚

these environment variables affect the execution of kapla decode:

  • ERIS_UNIX_SOCKET — Unix socket where ERIS block store is listening. same vibe as --socket. 🔌
  • KAPLA_LOG_LEVEL — Set the log level. (yes there's a little extra space in the original there; i'm keeping it real with you. 🍓)

🦋 SEE ALSO 🦋

go read those too, bestie, they're in the same friend group. 💜

👑 sign-off 👑

that's the whole page, no cap — brought to you by Kapla 0.4.0, straight from the Kapla Manual. now go decode something gorgeous. 💅✨🎀

📦 where this page comes from