GNUNET-CADET(1)

✨ GNUNET-CADET ✨

okay bestie, welcome to the gnunet-cadet manual page πŸ’– it lives in the General Commands Manual section of the GNUnet docs and it's genuinely such a vibe, no cap.


🌸 NAME 🌸

gnunet-cadet β€” create or obtain information about CADET tunnels and peers πŸ¦‹


πŸŽ€ SYNOPSIS πŸŽ€

gnunet-cadet [-C CONNECTION_ID | --connection=CONNECTION_ID]
             [-d | --dump] [-e | --echo]
             [-o SHARED_SECRET | --open-port=SHARED_SECRET]
             [-p PEER_ID | --peer=PEER_ID] [-P | --peers]
             [-T | --tunnels] [-c FILENAME | --config=FILENAME]
             [-h | --help] [-l FILENAME | --logfile=FILENAME]
             [-L LOGLEVEL | --loglevel=LOGLEVEL] [-v | --version]
             ⟨PEER_ID⟩ ⟨SHARED_SECRET⟩

πŸ’… DESCRIPTION πŸ’…

so gnunet-cadet prints info about CADET tunnels and peers, periodt. it's giving lookup tool energy.

but ALSO β€” and this is the iconic part β€” you can use it for command-line based CADET tunnels. how? you take the -o SHARED_SECRET option to open a port on a receiving PEER_ID, and then from any other peer you run:

gnunet-cadet ⟨PEER_ID⟩ ⟨SHARED_SECRET⟩

and boom πŸ’₯ you establish one circuit</> to that peer. one. single. circuit.

🫢 heads up bestie: the receiving process will only accept one incoming circuit at a time. but don't stress β€” you can just fire off several commands using the same -o to satisfy multiple requests. slay.

and if you're out here needing one-to-many communication? gnunet-social(1) might lowkey be better suited, js. πŸ™ˆ

okay now the full menu of options, buckle up πŸ‘‘

  • -C CONNECTION_ID, --connection=CONNECTION_ID β€” spill the tea about the connection CONNECTION_ID πŸ”
  • -d, --dump β€” dump debug information to stderr. messy but informative πŸ’€
  • -e, --echo β€” activate echo mode. hello? hello?? hello??? πŸ—£οΈ
  • -o SHARED_SECRET, --open-port=SHARED_SECRET β€” listen for connections using a shared secret, provided as SHARED_SECRET, among sender and recipient πŸ” (it's a secret, keep it between us bestie)
  • -p PEER_ID, --peer=PEER_ID β€” give me all the info about the peer PEER_ID 🧚
  • -P, --peers β€” info about all (known) peers. the whole friend group 🌈
  • -T, --tunnels β€” info about all tunnels. every single one πŸš‡
  • -c FILENAME, --config=FILENAME β€” use the configuration file FILENAME πŸ“
  • -h, --help β€” print the help page. always there for you πŸ«‚
  • -l FILENAME, --logfile=FILENAME β€” configure logging to write logs to FILENAME πŸ“
  • -L LOGLEVEL, --loglevel=LOGLEVEL β€” use LOGLEVEL for logging. valid values are DEBUG, INFO, WARNING and ERROR ⚠️ (yes, those exact four, don't freestyle)
  • -v, --version β€” print the GNUnet version number πŸ‘‘

πŸ¦‹ SEE ALSO πŸ¦‹

the full documentation for gnunet is maintained as a Texinfo manual. if the info(1) and gnunet programs are properly installed at your site, then this command:

info gnunet

should give you access to the complete handbook πŸ“–, and this one:

info gnunet-c-tutorial

will give you access to a tutorial for developers πŸ§‘β€πŸ’»βœ¨

depending on your installation, this information is also available in gnunet(7) and gnunet-c-tutorial(7). iykyk πŸ’œ


😭 BUGS 😭

found a bug? not the cute kind? report it at https://bugs.gnunet.org or send electronic mail to ⟨gnunet-developers@gnu.org⟩. the devs want to hear from you fr fr 🫢


k bye bestie, go tunnel something iconic πŸ’–βœ¨ this page came from the Debian flavor of the manual, dated May 3, 2016 β€” and yes, it's the GNUNET-CADET(1) page, mwah πŸ’…πŸŽ€