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-ctl is still available but deprecated. Please use brainpalace for 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_URL is 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 (or BRAINPALACE_URL / DOC_SERVE_URL env 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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brainpalace_cli-26.7.12.tar.gz (469.5 kB view details)

Uploaded Jul 23, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

brainpalace_cli-26.7.12-py3-none-any.whl (594.5 kB view details)

Uploaded Jul 23, 2026 Python 3

File details

Details for the file brainpalace_cli-26.7.12.tar.gz.

File metadata

Download URL: brainpalace_cli-26.7.12.tar.gz
Upload date: Jul 23, 2026
Size: 469.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for brainpalace_cli-26.7.12.tar.gz
Algorithm	Hash digest
SHA256	`73444b20da8077164a31e451d59131aca16fbfdd6a4e059b566edd1eff020207`
MD5	`979f5311bbec1311e3bc29599df97c36`
BLAKE2b-256	`4f652bb751715b37f3bb63417da5c848719dd601722fd68c2290c2a611af979c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for brainpalace_cli-26.7.12.tar.gz:

Publisher: publish-to-pypi.yml on bxw91/brainpalace

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: brainpalace_cli-26.7.12.tar.gz
- Subject digest: 73444b20da8077164a31e451d59131aca16fbfdd6a4e059b566edd1eff020207
- Sigstore transparency entry: 2228404507
- Sigstore integration time: Jul 23, 2026
Source repository:
- Permalink: bxw91/brainpalace@21e18f4fcf7ce0de0aa8e8fc1f81c31d39d19937
- Branch / Tag: refs/tags/v26.7.12
- Owner: https://github.com/bxw91
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-to-pypi.yml@21e18f4fcf7ce0de0aa8e8fc1f81c31d39d19937
- Trigger Event: release