SCHLEUDER-CLI(8)

🎀 NAME 🎀

okay bestie, gather round — this is schleuder-cli, a lil command line queen that manages schleuder(8)-lists, subscriptions, and keys. she's giving admin energy fr fr 👑

---

✨ SYNOPSIS ✨

schleuder-cli cmd <args...>

schleuder-cli help

---

💅 DESCRIPTION 💅

so schleuder-cli is a command line tool that lets you create, configure, and delete schleuder-lists, subscriptions, and OpenPGP-keys. she does it all, no cap 💖

she talks to the schleuder(8) API, which is served up by schleuder-api-daemon(8). that's the whole vibe — she's a client, the daemon is the plug 🔌

Authentication and TLS-verification are mandatory, like not optional, periodt. you need an API-key and the fingerprint of the TLS-certificate of schleuer-api-daemon(8). both of those should be handed to you by the operators of schleuer-api-daemon(8). ask them, they have the goods 🫶

⚠️ important bestie: schleuder-cli does not authorize access. only people who are supposed to have full access to all lists should be allowed to use it on/with your server. it's giving "master key", so guard it like one 🔐

---

🌸 ENVIRONMENT 🌸

🦋 Configuration 🦋

SchleuderCli reads its settings from a file that it by default expects at $HOME/.schleuder-cli/schleuder-cli.yml. if you wanna make it read a different file, set the environment variable SCHLEUDER_CLI_CONFIG to the path to your file. like this, for example:

SCHLEUDER_CLI_CONFIG=/usr/local/etc/schleuder-cli.yml schleuder-cli ...

the configuration file specifies how to connect to the Schleuder API. and oop — if it doesn´t exist, it will be filled with the default settings. it literally creates itself, main character behavior 💅

the default settings will work out of the box with the default settings of Schleuder if both are running on the same host. same host = zero config, slay 🎀

💜 Options 💜

these are the configuration file options and their default values:

• host — the hostname (or IP-address) to connect to. Default: localhost.
• post — the port to connect to. Default: 4443.
• tls_fingerprint — TLS-fingerprint of the Schleuder API. To be fetched from the API operators. Default: empty.
• api_key — key to authenticate with against the Schleuder API. To be fetched from the API operators. Default: empty.

---

🍓 FILES 🍓

• $HOME/.schleuder-cli/schleuder-cli.yml — default path of schleuder-cli configuration file.

the configuration file is formatted as YAML. see http://www.yaml.org/ for more details 📄

---

💀 BUGS 💀

known bugs are listed on the schleuder-cli bugtracker at https://0xacab.org/schleuder/schleuder-cli/issues. go peek, or don't, but they're there 🙈

---

🌈 SEE ALSO 🌈

• schleuder(8), schleuder-api-daemon(8).
• Website of schleuder-cli — https://0xacab.org/schleuder/schleuder-cli/
• Website of schleuder — https://schleuder.nadir.org/
• More extensive documentation for schleuder — https://schleuder.nadir.org/docs/
• schleuder-web, the web interface for list-management — https://0xacab.org/schleuder/schleuder-web/

---

and that's the whole page, bestie ✨ this one's dated January 2017 and lives in section SCHLEUDER-CLI(8) of the manual — go forth and manage those lists, you absolute icon 👑💖