BrainPalace CLI
Command-line interface for managing AI agent memory and knowledge retrieval with the BrainPalace RAG server.
BrainPalace (formerly doc-serve) is an intelligent document indexing and semantic search system designed to give AI agents long-term memory. This CLI provides a convenient way to manage your BrainPalace server and knowledge base.
Why BrainPalace?
AI agents need persistent memory to be truly useful. BrainPalace provides the retrieval infrastructure that enables context-aware, knowledge-grounded AI interactions.
Search Capabilities
| Search Type | Description | Best For |
|---|---|---|
| Semantic Search | Natural language queries using OpenAI embeddings | Conceptual questions, related content |
| Keyword Search (BM25) | Traditional keyword matching with TF-IDF ranking | Exact matches, technical terms |
| Hybrid Search | Combines vector + BM25 approaches | General-purpose queries |
| GraphRAG | Knowledge graph retrieval | Understanding relationships |
Installation
Canonical path: the guided installer installs the CLI + server, configures a provider, and offers to wire your AI coding assistant(s) — Claude Code, Codex, OpenCode, Antigravity, skill-runtime — all in one run:
curl -sSL https://raw.githubusercontent.com/bxw91/brainpalace/main/scripts/setup.sh | bash
Just this package, via pip:
pip install brainpalace-cli
Quick Start
brainpalace init # Initialize project
brainpalace start # Start server
brainpalace index ./docs # Index documents
brainpalace query "search term"
Note: The legacy command
doc-svr-ctlis still available but deprecated. Please usebrainpalacefor new installations.
Development Installation
cd brainpalace-cli
poetry install
Usage
# Check server status
brainpalace status
# Search documents
brainpalace query "how to use python"
# Index documents from a folder
brainpalace index ./docs
# Reset/clear the index
brainpalace reset --yes
Configuration
Set the server URL via environment variable:
export BRAINPALACE_URL=http://localhost:8000
Or use the --url flag:
brainpalace --url http://localhost:8000 status
Note: The legacy environment variable
DOC_SERVE_URLis still supported for backwards compatibility.
Commands
Server Management
| Command | Description |
|---|---|
init |
Initialize project for BrainPalace (creates .claude/brainpalace/) |
start |
Start the BrainPalace server for current project |
stop |
Stop the running server |
list |
List all running BrainPalace instances |
status |
Check server health and indexing status |
Data Management
| Command | Description |
|---|---|
query |
Search indexed documents |
index |
Start indexing documents from a folder |
reset |
Clear all indexed documents |
Options
All commands support:
--url- Server URL (orBRAINPALACE_URL/DOC_SERVE_URLenv var)--json- Output as JSON for scripting
Example Workflow
# 1. Initialize a new project
cd my-project
brainpalace init
# 2. Start the server
brainpalace start
# 3. Index your documentation
brainpalace index ./docs ./src
# 4. Query your knowledge base
brainpalace query "How does authentication work?"
# 5. Stop when done
brainpalace stop
Documentation
- User Guide - Getting started and usage
- Developer Guide - Contributing and development
- API Reference - Full API documentation
Release Information
- Current Version: See pyproject.toml
- Release Notes: GitHub Releases
- Changelog: Latest Release
Related Packages
- brainpalace-rag - The RAG server that powers BrainPalace
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file brainpalace_cli-26.7.13.tar.gz.
File metadata
- Download URL: brainpalace_cli-26.7.13.tar.gz
- Upload date:
- Size: 510.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
179e7c2fc8ba9df0205006c0db18ed406036d20dc2828232e1500eab760cb3bb
|
|
| MD5 |
d327f4e7a40319f671aaa464fb13e372
|
|
| BLAKE2b-256 |
a950a947ef96c566381d1992be45b864a3a215d2dc8b025070bc59842df4eb8f
|
Provenance
The following attestation bundles were made for brainpalace_cli-26.7.13.tar.gz:
Publisher:
publish-to-pypi.yml on bxw91/brainpalace
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
brainpalace_cli-26.7.13.tar.gz -
Subject digest:
179e7c2fc8ba9df0205006c0db18ed406036d20dc2828232e1500eab760cb3bb - Sigstore transparency entry: 2289474078
- Sigstore integration time:
-
Permalink:
bxw91/brainpalace@ede0e63a833b5dd5b99c33d06d7627c18fd5dbed -
Branch / Tag:
refs/tags/v26.7.13 - Owner: https://github.com/bxw91
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@ede0e63a833b5dd5b99c33d06d7627c18fd5dbed -
Trigger Event:
release
-
Statement type:
File details
Details for the file brainpalace_cli-26.7.13-py3-none-any.whl.
File metadata
- Download URL: brainpalace_cli-26.7.13-py3-none-any.whl
- Upload date:
- Size: 647.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e8458a335b43c7d5daf94089a64447161219715f9306532f2f7418d1eb468e74
|
|
| MD5 |
f54eeab4792e45f79e5cec7a28d9e843
|
|
| BLAKE2b-256 |
39bb70f5317c272cacf66cf3b0c0e33eb229ccddb6d92296680981142beec91c
|
Provenance
The following attestation bundles were made for brainpalace_cli-26.7.13-py3-none-any.whl:
Publisher:
publish-to-pypi.yml on bxw91/brainpalace
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
brainpalace_cli-26.7.13-py3-none-any.whl -
Subject digest:
e8458a335b43c7d5daf94089a64447161219715f9306532f2f7418d1eb468e74 - Sigstore transparency entry: 2289474134
- Sigstore integration time:
-
Permalink:
bxw91/brainpalace@ede0e63a833b5dd5b99c33d06d7627c18fd5dbed -
Branch / Tag:
refs/tags/v26.7.13 - Owner: https://github.com/bxw91
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@ede0e63a833b5dd5b99c33d06d7627c18fd5dbed -
Trigger Event:
release
-
Statement type:
