Setup guide — ← back to docs
Requirements
Python 3.11 or newer, and Linux. Cinnasole checks for Linux on every launch and will refuse to run anywhere else.
Get the file
Download cinnasole.py from the
Download page. It's a single
self-contained file — run it directly with
python3, no separate install step required.
Run it directly
From the folder you downloaded it to:
python3 cinnasole.py— opens this website in your browser.python3 cinnasole.py --start— opens the interactive prompt.
Optional dependencies
Cinnasole works out of the box with just the Python standard library. A handful of commands get better with a couple of extras installed, and fall back gracefully if they're missing:
-
whoisandnmapuse the systemwhois/nmaputilities if present (sudo pacman -S whois nmapon Arch). Without them, both commands fall back to a simpler built-in check instead of failing outright. -
crackcan recover passwords on PDF files if thepikepdfPython package is installed (pip install pikepdf). Zip file support needs nothing extra — it's built into Python already. -
--editneedsnano, and will offer to install it viapacmanautomatically if it isn't already on your system.
None of these are required to use Cinnasole — every command tells you plainly what's missing and how to get it, if and when you actually run into that gap.
Next
Once you're up and running, see command examples for the interactive prompt, or the flags walkthrough for everything that runs before the prompt starts.