Skip to main content

Documentation Index

Fetch the complete documentation index at: https://slackhive.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The 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 --version to 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

PlatformSupportedCredential source for OAuth path
macOS (Intel + Apple Silicon)Keychain
Linux with GNOME/KDE keyringsecret-tool
Linux headless (server)~/.claude/.credentials.json
WSL2 on Windows~/.claude/.credentials.json
Windows (native)Use WSL2

Install the CLI

npm install -g slackhive
If you installed Node from nodejs.org on macOS/Linux, /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:
mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc   # or ~/.bashrc
source ~/.zshrc
npm install -g slackhive
Installing Node via nvm or Homebrew (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

slackhive init
The wizard asks a few questions:
PromptWhat to enter
Install directoryWhere to put SlackHive (default: ./slackhive)
Admin usernameYour login for the dashboard
Admin passwordA strong password
Claude authPick API key or OAuth from Claude Code
Once you confirm, the CLI:
  1. Clones the SlackHive repo into your install directory
  2. Generates a .env file with a fresh encryption key
  3. Installs dependencies and builds the web + runner apps
  4. Starts the services
First run takes 2–3 minutes while everything builds.

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:
PlatformPrimary sourceFallback
macOSKeychain (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 login at 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-code or download the app

Linux notes

  • GNOME Keyring users: run claude login, secret-tool stores it, the CLI picks it up
  • Headless servers (no keyring daemon): run claude login anyway - it writes ~/.claude/.credentials.json as a plain file the CLI reads
  • If claude login fails with “keyring unavailable”, set DBUS_SESSION_BUS_ADDRESS or install a lightweight keyring (gnome-keyring-daemon --start). Last resort: copy ~/.claude/.credentials.json from 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 your ANTHROPIC_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:
http://localhost:3001
Log in with the admin credentials you set. You’re ready to create your first agent.

Where things live

PathWhat it holds
~/.slackhive/data.dbSQLite 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.logRunner log (also streamed live in the UI)
~/.slackhive/runner.lockSingle-runner lock file

Next steps

Create your first agent

Walk the 5-step wizard.

CLI operations

start, stop, status, logs, update.