Flags walkthrough — ← back to docs
Flags run directly from your shell, before the interactive
prompt starts — python3 cinnasole.py --start,
not a command typed after launching. For the full list with
one-line descriptions, see the About
page. This page covers the ones worth understanding before you
use them.
--start
Opens the interactive cinnasole> prompt. This is
the one you'll use the most — everything else on this page
is a one-off action, not something you run every session.
Worth knowing: python3 cinnasole.py with no flag at
all does not open the prompt — it opens this
website in your browser instead. You need --start
specifically to reach the prompt.
--edit and --restart, together
--edit opens Cinnasole's own source file in
nano, so you can make changes directly. It's a real
warning prompt, not a formality — editing the source can
genuinely break commands if something goes wrong, and Cinnasole
says so before proceeding:
python3 cinnasole.py --edit
===================
ARE YOU SURE?
===================
Running cinnasole --edit gives you access to the code...
Are you sure? [Y/N]
Answer Y and nano opens on the real file. If nano
isn't installed, Cinnasole offers to install it first rather than
just failing. Make your changes, save, and exit nano as normal.
Your edits don't take effect in a session that's already
running — that's what --restart is for:
python3 cinnasole.py --restart
This re-runs Cinnasole in place, in the same terminal window, picking up whatever you just changed. It's not closing and reopening your terminal emulator — just restarting the Cinnasole process itself, so your edits are live immediately.
--wipe
Deletes Cinnasole's own file from your machine, for real, after one confirmation:
python3 cinnasole.py --wipe
==================
CINNASOLE --WIPE
==================
This will permanently delete: /path/to/cinnasole.py
Are you sure you want to do this? [Y/N]
Answering Y deletes the file and confirms it did.
There's no staged uninstall process beyond that — it
removes the one file and tells you plainly that it's gone.
Answering N (or anything other than an explicit
yes) aborts and leaves the file untouched.
--version, --github / --gh, --type
These three are read-only — none of them change anything on your machine.
-
--versionchecks the latest release on GitHub and shows it alongside the version you're currently running, so you can tell at a glance if you're behind. -
--github(or the shorter--gh) opens the GitHub repo in your default browser. -
--typeprints what Cinnasole is built on.