-
Notifications
You must be signed in to change notification settings - Fork 2
Command Start
Rick Hightower edited this page Feb 2, 2026
·
1 revision
name: agent-brain-start description: Start the Agent Brain server for this project parameters:
- name: daemon description: Run in background (default true) required: false default: true skills:
- using-agent-brain
Starts the Agent Brain server for the current project. The server provides:
- Document indexing and storage
- Hybrid, semantic, and keyword search
- Multi-instance support with automatic port allocation
/agent-brain-start [--daemon]
| Parameter | Required | Default | Description |
|---|---|---|---|
| daemon | No | true | Run server in background |
Verify the project is initialized:
# Check for .claude/agent-brain/ directory
ls -la .claude/agent-brain/If not initialized:
agent-brain init# Start in background (recommended)
agent-brain start --daemon
# Start in foreground (for debugging)
agent-brain startagent-brain statusStarting Agent Brain server...
Server started successfully!
URL: http://127.0.0.1:49321
Port: 49321
Mode: project
Project: my-project
PID: 12345
Runtime config saved to: .claude/agent-brain/runtime.json
To check status: agent-brain status
To stop server: agent-brain stop
The server creates a runtime file at .claude/agent-brain/runtime.json:
{
"mode": "project",
"port": 49321,
"base_url": "http://127.0.0.1:49321",
"pid": 12345,
"project_id": "my-project",
"started_at": "2026-01-31T10:30:00Z"
}This file enables automatic server discovery for CLI commands.
Error: Project not initialized for Agent Brain
Run 'agent-brain init' first to initialize this project.
Resolution:
agent-brain init
agent-brain start --daemonError: Agent Brain server already running on port 49321
PID: 12345
To restart: agent-brain stop && agent-brain start --daemon
Resolution:
- Use existing server, or
- Stop and restart:
agent-brain stop && agent-brain start --daemon
Error: Port 8000 already in use
Agent Brain will automatically find an available port.
Starting on port 49322...
Agent Brain automatically allocates an available port when the default is busy.
Warning: OPENAI_API_KEY not set
Server will start, but semantic search will be unavailable.
To enable semantic search:
export OPENAI_API_KEY="sk-proj-..."
Resolution: Set the API key and restart:
export OPENAI_API_KEY="sk-proj-..."
agent-brain stop
agent-brain start --daemonError: Permission denied when creating runtime directory
Resolution:
mkdir -p .claude/agent-brain
chmod 755 .claude/agent-brain
agent-brain start --daemonagent-brain status# Index documentation
agent-brain index docs/
# Index code files
agent-brain index src/ --include-codeagent-brain query "test query" --mode hybrid- Server runs for a single project
- Data stored in
.claude/agent-brain/ - Automatic port allocation
- Isolated from other projects
DOC_SERVE_MODE=shared agent-brain start --daemon- Server serves multiple projects
- Data stored in
~/.agent-brain/ - Fixed port (default 8000)
- Shared index across projects
| Command | Description |
|---|---|
/agent-brain-init |
Initialize project for Agent Brain |
/agent-brain-status |
Check server status |
/agent-brain-stop |
Stop the server |
/agent-brain-list |
List all running instances |
-
Check for existing processes:
ps aux | grep agent-brain -
Check port availability:
lsof -i :8000
-
Check logs:
cat .claude/agent-brain/server.log
-
Verify Python environment:
which python python --version # Should be 3.10+ -
Verify installation:
pip show agent-brain-rag agent-brain-cli
-
Check for dependency issues:
pip check
- Design-Architecture-Overview
- Design-Query-Architecture
- Design-Storage-Architecture
- Design-Class-Diagrams
- GraphRAG-Guide
- Agent-Skill-Hybrid-Search-Guide
- Agent-Skill-Graph-Search-Guide
- Agent-Skill-Vector-Search-Guide
- Agent-Skill-BM25-Search-Guide
Search
Server
Setup
- Pluggable-Providers-Spec
- GraphRAG-Integration-Spec
- Agent-Brain-Plugin-Spec
- Multi-Instance-Architecture-Spec