KAPLA-PEER-ADD(1)

πŸ“¦ version 0.4.0, in nixpkgs unstable

πŸ’… kapla-peer-add(1) β€” like, the Kapla Manual, bestie ✨

okay so this is kapla-peer-add, one of the little helper pages that lives under the big kapla umbrella (you'll see it in SEE ALSO, obviously πŸ’–). It's short, it's sweet, it's giving "add a peer and go" energy.


🌸 NAME 🌸

kapla-peer-add β€” add a peer 🫢


✨ SYNOPSIS ✨

kapla peer add [OPTION]… URI

So the whole vibe is: you run kapla peer add, you hand it a URI, you sprinkle in [OPTION]… if you're feeling fancy, and boom β€” you've added a peer.

And what does that actually mean? It means you're adding a peer that gets persisted in a peer database. Like, it's not just a one-night stand of a connection, it's saved. Iconic. πŸ‘‘


πŸŽ€ ARGUMENTS πŸŽ€

  • URI (required) β€” the URI of the ERIS block store that should be added as peer. no URI, no peer, no slay. it's required, bestie, don't forget it πŸ’€

πŸ¦‹ OPTIONS πŸ¦‹

  • -a, --autoconnect β€” attempt to automatically connect to peer. key word attempt β€” that's what the manpage says, so that's what we're saying 🌈
  • -c CONTROL_SOCKET, --control=CONTROL_SOCKET β€” the Kapla control socket. and if you don't pass it, it falls back to these, in this order:
    • $XDG_STATE_HOME/kapla/kapla.sock
    • $HOME/.local/state/kapla/kapla.sock
    • /var/lib/kapla/kapla.sock
  • --name=NAME β€” peer nickname. and listen, the manpage is very clear here: this name is only used internaly as a nick name for connecting to or managing the peer. (that's their spelling of "internaly", we're keeping it exactly as-is, no cap πŸŽ€) so it's not a public flex, it's an internal nickname situation.
  • --share β€” allow peer to be shared via peer discovery. share the peer, share the love 🫢

πŸ’œ COMMON OPTIONS πŸ’œ

  • --color=WHEN (absent=auto) β€” colorize the output. 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. and with auto, the format is pager or plain whenever the TERM env var is dumb or undefined. cute. very demure 🌸
  • -q, --quiet β€” be quiet. takes over -v and --verbosity. it's literally the loudest thing in the room by being silent πŸ’€
  • -v, --verbose β€” increase verbosity. it's repeatable, but more than twice does not bring more. so like... -vv is the limit of usefulness, go off though πŸ™ˆ
  • --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. takes over -v. so it's the main character here πŸ‘‘
  • --version β€” show version information. yes, the version info. we love a classic ⭐

πŸ”₯ EXIT STATUS πŸ”₯

kapla peer add exits with:

  • 0 β€” on success. πŸŽ‰ slay!
  • 123 β€” on indiscriminate errors reported on standard error.
  • 124 β€” on command line parsing errors. (you typed something weird, bestie 😭)
  • 125 β€” on unexpected internal errors (bugs).
okay so lowkey if you get 125 that's a bug β€” the manpage literally says so. not your fault, fr fr πŸ’€

🌈 ENVIRONMENT 🌈

these environment variables affect the execution of kapla peer add:

  • KAPLA_LOG_LEVEL β€” set the log level. yes. that's the whole description. it sets the log level. we're not making anything up 🧚

⭐ SEE ALSO ⭐

  • kapla(1) β€” the mothership. go read it, iykyk πŸ’–

and that's the whole page, bestie! nothing skipped, nothing hidden, every flag accounted for 🫢

sign-off time ✨ this lil beauty comes from Kapla 0.4.0, straight out of the Kapla Manual β€” go forth and add those peers, you absolute icon πŸ‘‘πŸ’…πŸŽ€

πŸ“¦ where this page comes from