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 CLI installs, configures, and runs SlackHive on your machine. It clones the repo, generates a .env file, installs dependencies, builds the apps, and starts the services. Data lands in a local SQLite database.
Prerequisites
- Node.js 20 or later -
node --versionto check - Claude Code installed - claude.ai/code (for OAuth path) or an Anthropic API key (for key path)
- A Slack workspace where you can install apps
- Git (for the initial clone)
Platform support
| Platform | Supported | Credential source for OAuth path |
|---|---|---|
| macOS (Intel + Apple Silicon) | ✅ | Keychain |
| Linux with GNOME/KDE keyring | ✅ | secret-tool |
| Linux headless (server) | ✅ | ~/.claude/.credentials.json |
| WSL2 on Windows | ✅ | ~/.claude/.credentials.json |
| Windows (native) | ❌ | Use WSL2 |
Install the CLI
Hit EACCES: permission denied?
Hit EACCES: permission denied?
If you installed Node from nodejs.org on macOS/Linux, Installing Node via nvm or Homebrew (
/usr/local/lib/node_modules is root-owned and npm install -g fails without sudo. Point npm at a user-owned prefix - one-time setup:brew install node) avoids this entirely - both install Node in a user-writable location. Or skip global install with npx slackhive init (prefix every command with npx).Run the setup wizard
| Prompt | What to enter |
|---|---|
| Install directory | Where to put SlackHive (default: ./slackhive) |
| Admin username | Your login for the dashboard |
| Admin password | A strong password |
| Claude auth | Pick API key or OAuth from Claude Code |
- Clones the SlackHive repo into your install directory
- Generates a
.envfile with a fresh encryption key - Installs dependencies and builds the web + runner apps
- Starts the services
OAuth pickup - macOS vs Linux
If you chose the OAuth (Pro/Max subscription) path, the CLI pulls your Claude Code credentials from the system credential store. The source differs by platform:| Platform | Primary source | Fallback |
|---|---|---|
| macOS | Keychain (security find-generic-password -s "Claude Code-credentials") | ~/.claude/.credentials.json |
| Linux (GNOME) | secret-tool lookup service "Claude Code-credentials" | ~/.claude/.credentials.json |
| Linux (headless) | - | ~/.claude/.credentials.json |
macOS notes
- You must have run
claude loginat least once - credentials land in Keychain automatically - SlackHive re-syncs from Keychain when the cached token expires. No manual action needed most of the time
- To install from scratch:
brew install anthropic-ai/claude/claude-codeor download the app
Linux notes
- GNOME Keyring users: run
claude login,secret-toolstores it, the CLI picks it up - Headless servers (no keyring daemon): run
claude loginanyway - it writes~/.claude/.credentials.jsonas a plain file the CLI reads - If
claude loginfails with “keyring unavailable”, setDBUS_SESSION_BUS_ADDRESSor install a lightweight keyring (gnome-keyring-daemon --start). Last resort: copy~/.claude/.credentials.jsonfrom another machine where login worked
Either way, no manual token paste. The CLI prints which source it used so you can verify.
API key path (both platforms)
If you pick the API key option, none of the above applies. You’re asked for yourANTHROPIC_API_KEY, it’s written to .env, and that’s it. Works identically on macOS, Linux, and WSL.
Open the dashboard
When the wizard finishes:Where things live
| Path | What it holds |
|---|---|
~/.slackhive/data.db | SQLite database - agents, memories, skills, history |
~/.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 | Runner log (also streamed live in the UI) |
~/.slackhive/runner.lock | Single-runner lock file |
Next steps
Create your first agent
Walk the 5-step wizard.
CLI operations
start, stop, status, logs, update.