KAPLA-ENCODE(1)

📦 version 0.4.0, in nixpkgs unstable

🎀 NAME 🎀

kapla-encode — the way you encode content using ERIS, bestie ✨

(also hi, this whole thing lives in the Kapla Manual, so like… you're in the right place 💅)

✨ SYNOPSIS ✨

kapla encode [OPTION]… [INPUT]

Encode your content, stash the blocks, and print out the read capability. That's it, that's the vibe 🦋

🌸 ARGUMENTS 🌸

  • INPUT (absent=-) — the path to the content you wanna encode. Pass - for stdin, easy. And if you hand it a directory? Then the directory content gets encoded using ERIS-FS. no cap 🔥

💖 OPTIONS 💖

  • -b BLOCK_SIZE, --block-size=BLOCK_SIZE (absent=32768) — size of the blocks your content gets encoded into. Only two values are allowed, so don't get creative: 1024 (or the alias small) and 32768 (or the alias large). periodt.
  • -c, --null-convergence — use convergent encryption with the null convergence secret. yes queen, converge.
  • --cbor=CBOR_FILE — write blocks of encoded content to a CBOR Sequence file. If the file already exists, the blocks get appended — like, added onto the end, nothing gets yeeted 🙈
  • -n, --no-store — do not upload blocks to the store. not me skipping the upload 💀
  • -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, iykyk.
  • --sqlite=SQLITE_DB — store blocks of encoded content into an SQLite database. iconic little database moment 🫶

👑 COMMON OPTIONS 👑

  • --color=WHEN (absent=auto) — colorize the output, obviously 💅 WHEN must be one of auto, always or never.
  • --help[=FMT] (default=auto) — show this help in format FMT. 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. (so like, it reads the room 🧚)
  • -q, --quiet — be quiet. takes over -v and --verbosity. shhh 🤫
  • -v, --verbose — increase verbosity. repeatable, but more than twice does not bring more — so don't spam it thinking it'll unlock secret levels, it won't ⭐
  • --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 encode 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. oops 😭
  4. 125 — on unexpected internal errors (bugs). not the bugs 💀

🌈 ENVIRONMENT 🌈

These environment variables affect the execution of kapla encode, bestie:

  • ERIS_UNIX_SOCKET — Unix socket where ERIS block store is listening.
  • KAPLA_LOG_LEVEL — Set the log level.

🦋 EXAMPLES 🦋

To encode a file and share the read capability as a QR code:

kapla encode file.txt | qrencode -t UTF8

literally so cute, go off 🎀

⭐ STANDARDS ⭐

💜 SEE ALSO 💜

kapla-decode(1), kapla-serve(1)

okay that's the whole thing!! this page? Kapla 0.4.0, from the Kapla Manual, and it's the KAPLA-ENCODE(1) entry — ily, go encode something gorgeous 🌸✨

📦 where this page comes from