KAPLA-SERVE(1)

📦 version 0.4.0, in nixpkgs unstable

✨ KAPLA-SERVE ✨

okay so bestie, gather round, because this is the Kapla Manual page for kapla-serve and it's literally the main character of the whole local-block situation 💅

🌸 NAME 🌸

kapla-serve — start the Kapla server and make blocks available over TCP/IP and Unix sockets 🫶

🎀 SYNOPSIS 🎀

kapla serve [--data=DATA_DIR] [--socket=ERIS_UNIX_SOCKET]
[--state=STATE_DIR] [OPTION]…

So the Kapla server is the thing that stores blocks of ERIS encoded content and then hands them out over the network (via TCP/IP) and locally (via Unix Domain Sockets). It's giving storage queen, it's giving availability icon 👑

And no cap, this part matters: you need a Kapla server running to encode and decode content — even locally — with the encode and decode commands. Like, yes, even on your own machine, bestie. The server is not optional, it's the vibe check 🔥

🦋 THE CONSTRAINED APPLICATION PROTOCOL (CoAP) 🦋

The Kapla server accepts connections over TCP/IP and Unix Domain Sockets using the Constrained Application Protocol, aka CoAP, as defined in RFC 7252 ✨

The interface it exposes is a bunch of CoAP endpoints for storing or retrieving blocks, and it's all documented in the document "ERIS over CoAP". Go read it, iykyk 📖

🌈 PROXY TO OTHER NETWORKS AND TRANSPORTS 🌈

Kapla can connect to other networks and transports using proxies. A proxy is an application that speaks CoAP to Kapla and forwards block requests off to some other network. Middleware but make it cute 🧚

See the document "ERIS over CoAP" for more info, bestie 💖

⭐ STANDARDS ⭐

(it's giving bibliography slay, we love a documented queen 💅)

✨ OPTIONS ✨

  • --data=DATA_DIR — data directory where blocks are stored. if it's absent, it falls back to $XDG_DATA_HOME/kapla/, ~/.local/share/kapla or /var/lib/kapla/ 🍓
  • -s ERIS_UNIX_SOCKET, --socket=ERIS_UNIX_SOCKET — the Unix Socket to listen on as an ERIS block server. absent, it's STATE_DIR/eris.sock, or whatever the ERIS_UNIX_SOCKET env says 🌸
  • --state=STATE_DIR — state directory where the Unix socket and lock files get created. absent, it's $XDG_STATE_HOME/kapla/, $HOME/.local/state/kapla or /var/lib/kapla/ 🎀

💜 COMMON OPTIONS 💜

  • --color=WHEN — colorize the output. WHEN has to be one of auto, always or never. absent = auto 🌈
  • --help[=FMT] — 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. default = auto 👑
  • -q, --quiet — be quiet. takes over -v and --verbosity. shhh, she's resting 😴
  • -v, --verbose — increase verbosity. repeatable, but more than twice does not bring more. two is the limit, bestie, that's the ceiling 💀
  • --verbosity=LEVEL — be more or less verbose. LEVEL must be one of quiet, error, warning, info or debug. takes over -v. absent = warning or the KAPLA_LOG_LEVEL env 💬
  • --version — show version information 🏷️

🔥 EXIT STATUS 🔥

kapla serve exits with:

  • 0 — on success. we love a win 🎉
  • 123 — on indiscriminate errors reported on standard error 😭
  • 124 — on command line parsing errors 🙈
  • 125 — on unexpected internal errors (bugs). not me, not my fault 💀

🧚 ENVIRONMENT 🧚

These environment variables affect the execution of kapla serve:

  • ERIS_UNIX_SOCKET — Unix Socket to listen on as an ERIS block server 🦋
  • KAPLA_LOG_LEVEL — set the log level 📊

💖 SEE ALSO 💖

and that's the whole page, bestie! this gorgeous document comes to you courtesy of Kapla 0.4.0 and the KAPLA-SERVE(1) footer energy — go forth and serve those blocks, you absolute icon 👑💅✨

📦 where this page comes from