Once you’ve installed SlackHive, theDocumentation Index
Fetch the complete documentation index at: https://slackhive.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
slackhive command is your day-to-day control surface - simple verbs for start, stop, status, logs, and update.
slackhive status
Show whether SlackHive is running and where.
- Whether the web UI is up and on which port
- Whether the runner is up and its PID
- The path to
~/.slackhive/(data and logs)
slackhive logs
Tail the runner log live.
--follow by default. Ctrl-C to stop.
The log is JSON per line. To filter to a single agent:
slackhive stop
Gracefully stop SlackHive.
- Sends SIGTERM to the managed runner and the web server
- Sweeps any orphan runner processes (e.g. an accidental
tsx watchfrom a previous dev session) - Unlinks the
~/.slackhive/runner.lockfile
kill.
slackhive start
Start SlackHive.
- Checks
~/.slackhive/runner.lock- if another runner is alive, exits with a clear error - If the lock is stale (the PID isn’t alive), removes it automatically
- Picks free ports for the web and runner (default 3001 / 3002; auto-negotiates if taken)
- Writes the new PID into the lock
- Starts the web and runner
slackhive update
Pull the latest code and rebuild.
~/.slackhive/data.db) is preserved.
- npm install (recommended):
slackhive updatedetects your install type. If you installed via npm, it will tell you to runnpm update -g slackhiveinstead. - git clone install: runs
git pull,npm install, rebuilds the runner and web app, restarts.
git pull fails (e.g. local changes), stash them first: git stash && slackhive update.
Where data lives
| Path | What it holds |
|---|---|
~/.slackhive/data.db | SQLite DB - agents, memories, skills, history, settings |
~/.slackhive/agents/<slug>/ | Per-agent workspace (CLAUDE.md, sessions, copies of assigned wiki folders) |
~/.slackhive/knowledge/<folderId>/wiki/ | Compiled wikis for the Knowledge Library (source of truth) |
~/.slackhive/logs/runner.log | Full runner log stream |
~/.slackhive/runner.lock | Singleton lock - JSON with pid, startedAt, mode |
~/.slackhive/slackhive.pid | Web-server PID file |
~/.slackhive/ to preserve your entire install.
Running from any directory
slackhive commands work from anywhere on disk - the CLI finds the install via the apps/runner marker. You don’t need to cd into the repo.