FREEDOMBOX-CMD(1)

💖 FREEDOMBOX-CMD 💖

okay so bestie, we're doing the manual page for freedombox-cmd, the FreedomBox Command Line Utility 🎀✨

---

✨ NAME ✨

freedombox-cmd — the command line utility that does FreedomBox operations, like, from your terminal 💅

---

🌸 SYNOPSIS 🌸

freedombox-cmd [-h, --help] {module} {action} [--no-args]

---

🦋 DESCRIPTION 🦋

So FreedomBox? Iconic. It's a community project to develop, design and promote personal servers running free software for private, personal communications. Basically it's a networking appliance designed so you can interface with the rest of the Internet while keeping your privacy protected and your data secure. It hosts apps like blog, wiki, website, social network, email, web proxy and a Tor relay — all on a device that can literally replace your wireless router, so your data stays with you. Main character energy fr fr 👑

freedombox-cmd is a command line interface to some of the operations that FreedomBox performs. Real talk though: end users (the ones using FreedomBox's web interface) typically don't need it. It's for when you're debugging problems — especially when the web interface isn't accessible, or when there's some functionality that the web interface just doesn't provide and you need to trigger it manually. iykyk 😭

Here's the vibe of how it works: the command is simply a client to FreedomBox's privileged daemon, and it relays your request to it. Then it waits for the request to complete and prints out the output of the operation, or an error message collected from the daemon. The daemon only allows connections from a pre-allowed list of user accounts. So be sure to run the command as root superuser, okay? 💀

---

💅 OPTIONS 💅

• module — the name of the module you wanna execute an action from.
• action — the name of the action to execute. It should be found in the module you provided, no cap.
• --no-args — don't try to read the arguments to the command on standard input. Instead, assume the operation doesn't have any arguments and just execute the method without arguments.
• --help — shows brief help about the arguments allowed for this command.

---

🌈 EXAMPLES 🌈

🍓 Example 1. Re-run FreedomBox network setup

$ sudo freedombox-cmd networks setup --no-args

So when FreedomBox starts for the very first time, it sets up Network Manager connections suitable for the hardware it found. If you wanna re-create those connections later, you can re-run setup for the Networks app using the web interface, or just run this command in a terminal. Easy ✨

🧚 Example 2. Delete a user account from LDAP database

$ echo '{"args": ["USERNAME", "AUTH_USER", "AUTH_PASSWORD"], "kwargs": {}}' | sudo freedombox-cmd users remove_user

Let's break it down:

• USERNAME is the name of the user account that must be removed.
• AUTH_USER is the name of the user account that is authorizing this operation.
• AUTH_PASSWORD is the password for the user account that is authorizing this operation.

You might need this operation if FreedomBox's sqlite3 database got wiped — which removes the user accounts in the database but not the corresponding entries from the LDAP database. And here's the thing: a new user with that name can't be created until the LDAP account is also removed. So yeah, gotta clean it up 🙈

⭐ Example 3. Set the logging mode to persistent

$ echo '{"args": ["persistent"], "kwargs": {}}' | sudo freedombox-cmd config set_logging_mode

By default, FreedomBox sets up systemd-journald to 'volatile' logging. Which means logs will not be stored on the disk and will be lost after a reboot 😭 So if you're tackling a problem and you want those logs stored persistently, you can change the setting in the web interface, or run this command. Chef's kiss 🫶

---

💀 BUGS 💀

See the FreedomBox issue tracker[1] for a full list of known issues and TODO items.

---

👑 AUTHOR 👑

FreedomBox Developers

---

📝 NOTES 📝

1. FreedomBox issue tracker https://salsa.debian.org/freedombox-team/freedombox/issues

---

that's the whole page bestie, slay 💖 and like, credit where it's due: this was FreedomBox Command Line Utility, dated 08/22/2026 — go off, FREEDOMBOX-CMD(1) periodt 🌸✨