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
Metadata
1 maintainer
Release files for brainpalace-cli 26.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| brainpalace_cli-26.8.2.tar.gz | 525.3 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| brainpalace_cli-26.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / brainpalace_cli-26.8.2.tar.gz
| Download URL | brainpalace_cli-26.8.2.tar.gz |
|---|---|
| Size | 525.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
61b6076dcaa45aabbc54da68fb03385040d1b375f3137a1da0c3576db353ebbe
|
|
BLAKE2b-256 checksum How to use checksums |
b0e2e9317c127e55763a2fd56265af49df3277842404914d868c4826eaca33bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 23, 2026.
Transparency logRelease files / brainpalace_cli-26.8.2-py3-none-any.whl
| Download URL | brainpalace_cli-26.8.2-py3-none-any.whl |
|---|---|
| Size | 663.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
37fd1aa88805436f849ea77fa167ca23e23d30c006fd46f1ab3f198f31158988
|
|
BLAKE2b-256 checksum How to use checksums |
38e337087dc1cb6bf5e04ee98c6449cc605c2c665b9af45f411e9265896a1bfd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 23, 2026.
Transparency logSecurity for brainpalace-cli 26.8.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for brainpalace_cli-26.8.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 23, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
