Reference
Commands and options
Everything slowship understands, on one page.
#Commands
| Command | What it does |
|---|
slowship [dir] | Read dir (here by default), show the verdict, then offer the review. |
slowship review | Review the last watch again, full screen in the terminal. |
slowship ui | Open the morning report in your browser. |
slowship schedule [dir] | Keep watch every night. See The nightly watch. |
slowship discord | Connect a Discord channel for the morning ping. |
slowship telegram | Connect a Telegram chat for the morning ping. |
slowship notify | Show, test or stop the morning ping. |
slowship connect | Print how to connect your coding agent, and install its skill. |
slowship mcp | The MCP server your agent talks to. Your agent starts it; you don’t need to. |
slowship help | The mark and the list of commands. |
#Watch options
| Option | What it does |
|---|
--app <folder> | Also check your own build before it ships. |
--no-model | Rules only, no local model. |
--packages-only | Read only the project’s packages. |
--agents-only | Read only agent skills and MCP servers. |
--offline | Don’t download npx MCP servers to read them. |
--json <file> | Write everything found as JSON. |
--approve <name|notable|review> | Clear one item, or everything at that level and below. See Clearing things. |
--notify | Send the morning ping after this watch too. |
--plain | Plain text: no colour, no screens. Automatic when piped. |
--no-motion | Draw, but don’t animate. |
#Other options
| Command | Options |
|---|
slowship ui | --port 7798 to choose the port, --no-open to start without opening the browser. |
slowship schedule | --at 03:00 for the time, any watch option to keep for the nightly run, --status to see what’s set, --off to stop it. |
slowship notify | test sends one now. off [discord|telegram|all] disconnects. when needs|always chooses when it sends. manual on|off also sends after watches you start. |
#Environment variables
| Variable | What it does |
|---|
SLOWSHIP_MODEL | The Ollama model to use. Default gemma4:e2b. |
SLOWSHIP_HOME | Where slowship keeps its memory. Default ~/.slowship. |
SLOWSHIP_REA | Where REA’s scripts/rea.mjs is, if it isn’t installed globally. |
SLOWSHIP_PORT | The report’s port, instead of --port. |
SLOWSHIP_NO_MOTION | The same as --no-motion, everywhere. |
NO_COLOR | Plain text, like --plain. |
#Exit codes
2 when the verdict is held, so it can gate CI; 0 otherwise. The nightly task always exits cleanly; the verdict waits in the report.
#Files
| File | Holds |
|---|
~/.slowship/state.json | The memory of what was read, by fingerprint, and your clears. |
~/.slowship/notify.json | The morning ping’s webhook or token, readable only by you. |
Suggest a change to this page