-
Notifications
You must be signed in to change notification settings - Fork 2
Command Help
Rick Hightower edited this page Feb 2, 2026
·
1 revision
name: agent-brain-help description: Show available Agent Brain commands and usage parameters:
- name: command description: Specific command to get help for required: false skills:
- using-agent-brain
- agent-brain-setup
Displays available Agent Brain commands and usage information. Without parameters, shows a summary of all commands. With a specific command name, shows detailed help for that command.
/agent-brain-help [--command <name>]
| Parameter | Required | Default | Description |
|---|---|---|---|
| --command | No | - | Specific command to get detailed help for |
/agent-brain-help # Show all commands
/agent-brain-help --command search # Detailed help for search
/agent-brain-help --command index # Detailed help for index
Display the complete command reference:
Agent Brain Commands
====================
SEARCH COMMANDS
agent-brain-search Hybrid BM25+semantic search (recommended default)
agent-brain-semantic Pure semantic vector search for conceptual queries
agent-brain-keyword Pure BM25 keyword search for exact terms
SETUP COMMANDS
agent-brain-install Install Agent Brain packages from PyPI
agent-brain-setup Complete guided setup (install, config, init, verify)
agent-brain-config Configure API keys (OPENAI_API_KEY, ANTHROPIC_API_KEY)
agent-brain-init Initialize Agent Brain for current project
agent-brain-verify Verify installation and configuration
SERVER COMMANDS
agent-brain-start Start the Agent Brain server for this project
agent-brain-stop Stop the running server
agent-brain-status Show server status, port, and document count
agent-brain-list List all running Agent Brain instances
INDEXING COMMANDS
agent-brain-index Index documents for search
agent-brain-reset Clear the document index (requires confirmation)
HELP
agent-brain-help Show this help message
Use '/agent-brain-help --command <name>' for detailed help on any command.
Display detailed information for the specified command:
agent-brain <command> --helpExample output for /agent-brain-help --command search:
agent-brain-search
==================
Hybrid BM25+semantic search combining keyword matching with semantic similarity.
This is the recommended default search mode for most queries.
USAGE
/agent-brain-search <query> [options]
PARAMETERS
query Required. The search query text.
--top-k Number of results (1-20). Default: 5
--threshold Minimum relevance score (0.0-1.0). Default: 0.3
--alpha Hybrid blend (0=BM25, 1=semantic). Default: 0.5
EXAMPLES
/agent-brain-search "authentication flow"
/agent-brain-search "error handling" --top-k 10
/agent-brain-search "OAuth" --alpha 0.3 --threshold 0.5
SEE ALSO
agent-brain-semantic For pure conceptual queries
agent-brain-keyword For exact term matching
Format as grouped table:
- Group by category (Search, Setup, Server, Indexing, Help)
- Show command name and brief description
- Include footer with how to get detailed help
Show comprehensive details:
- Full command name and description
- Usage syntax
- All parameters with types and defaults
- 2-3 practical examples
- Related commands (See Also)
| Command | Category | Description |
|---|---|---|
| agent-brain-search | Search | Hybrid BM25+semantic search |
| agent-brain-semantic | Search | Pure semantic vector search |
| agent-brain-keyword | Search | Pure BM25 keyword search |
| agent-brain-install | Setup | Install packages from PyPI |
| agent-brain-setup | Setup | Complete guided setup |
| agent-brain-config | Setup | Configure API keys |
| agent-brain-init | Setup | Initialize for current project |
| agent-brain-verify | Setup | Verify installation |
| agent-brain-start | Server | Start the server |
| agent-brain-stop | Server | Stop the server |
| agent-brain-status | Server | Show server status |
| agent-brain-list | Server | List all instances |
| agent-brain-index | Indexing | Index documents |
| agent-brain-reset | Indexing | Clear the index |
| agent-brain-help | Help | Show help |
| Error | Cause | Resolution |
|---|---|---|
| Unknown command | Invalid command name specified | Check spelling, use /agent-brain-help for list |
| Command not found | Typo in command parameter | Refer to command reference table above |
- All commands use the
agent-brain-prefix - Commands can be invoked as
/agent-brain-<name>in Claude Code - Setup commands are typically run once per project
- Search commands require a running server with indexed documents
- 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