nyx(1)

🌸 nyx 🌸

okay bestie, welcome to the nyx manual page — yeah it lives in the General Commands Manual, section 1, and it's literally the Tor terminal status monitor. pull up a chair, grab a boba, we're doing this 🧋💖

---

✨ NAME ✨

nyx — Tor terminal status monitor 🦋

---

✨ SYNOPSIS ✨

nyx [OPTION]

---

✨ DESCRIPTION ✨

Nyx is a command line interface for Tor (https://www.torproject.org/), and it's giving you detailed real-time relaying information for…

• bandwidth, cpu, and memory usage
• connection information
• tor configuration
• event logs
• etc

no cap, it's a whole vibe 💅

As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados to check the status of tor. like, if you're ssh'd in at 2am checking your relay, this is your moment, main character energy fr fr 👑

Nyx can be customized through a configuration file located at ~/.nyx/config. For options see https://nyx.torproject.org/#configuration. go look, i'll wait 🫶

---

✨ OPTIONS ✨

• -i, --interface [ADDRESS:]PORT — tor control port we should attach to (default is 127.0.0.1:9051)
• -s, --socket SOCKET_PATH — tor control socket we should attach to (default is /var/run/tor/control)
• -c, --config CONFIG_PATH — user configuration preferences (default is ~/.nyx/config)
• -d, --debug LOG_PATH — writes all nyx logs to the given location
• -l, --log EVENTS — comma separated list of events to log
• -v, --version — provides version information
• -h, --help — provides usage information

---

✨ FILES ✨

• ~/.nyx/config — Your personal nyx configuration file 💖
• /usr/share/doc/nyx/nyxrc.sample.gz — Sample nyxrc configuration file that documents all options ✨

---

✨ AUTHOR ✨

Written by Damian Johnson (atagar@torproject.org) 🎀

---

okay that's the whole thing, you're officially a nyx girlie now 💅🌸

this page is nyx(1) from the General Commands Manual, dated 27 August 2010 — yeah it's an elder but she ate and she's still iconic, periodt 👑🦋