Skip to main content

Agent Brain CLI - Command-line interface for managing AI agent memory and knowledge retrieval

Project description

Agent Brain CLI

Command-line interface for managing AI agent memory and knowledge retrieval with the Agent Brain RAG server.

Agent Brain (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 Agent Brain server and knowledge base.

PyPI version Python 3.10+ License: MIT

Why Agent Brain?

AI agents need persistent memory to be truly useful. Agent Brain 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

pip install agent-brain-cli

Quick Start

agent-brain init          # Initialize project
agent-brain start         # Start server
agent-brain index ./docs  # Index documents
agent-brain query "search term"

Note: The legacy command doc-svr-ctl is still available but deprecated. Please use agent-brain for new installations.

Development Installation

cd agent-brain-cli
poetry install

Usage

# Check server status
agent-brain status

# Search documents
agent-brain query "how to use python"

# Index documents from a folder
agent-brain index ./docs

# Reset/clear the index
agent-brain reset --yes

Configuration

Set the server URL via environment variable:

export AGENT_BRAIN_URL=http://localhost:8000

Or use the --url flag:

agent-brain --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 Agent Brain (creates .claude/agent-brain/)
start Start the Agent Brain server for current project
stop Stop the running server
list List all running Agent Brain 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 AGENT_BRAIN_URL / DOC_SERVE_URL env var)
  • --json - Output as JSON for scripting

Example Workflow

# 1. Initialize a new project
cd my-project
agent-brain init

# 2. Start the server
agent-brain start

# 3. Index your documentation
agent-brain index ./docs ./src

# 4. Query your knowledge base
agent-brain query "How does authentication work?"

# 5. Stop when done
agent-brain stop

Documentation

Release Information

Related Packages

License

MIT

Project details


Download files

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

Source Distribution

agent_brain_cli-10.3.0.tar.gz (90.4 kB view details)

Uploaded Source

Built Distribution

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

agent_brain_cli-10.3.0-py3-none-any.whl (117.8 kB view details)

Uploaded Python 3

File details

Details for the file agent_brain_cli-10.3.0.tar.gz.

File metadata

  • Download URL: agent_brain_cli-10.3.0.tar.gz
  • Upload date:
  • Size: 90.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agent_brain_cli-10.3.0.tar.gz
Algorithm Hash digest
SHA256 4874186cbe3ffb58f82367395cdb45c390b7948500bd269f3a41cc59c5fe2e58
MD5 478ff286cb85873eb508419c00f44aa2
BLAKE2b-256 8342b9f423ec1203457da031aa7ba2a686a5aa6c35716815f6d4eba799d74e8d

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_brain_cli-10.3.0.tar.gz:

Publisher: publish-to-pypi.yml on SpillwaveSolutions/agent-brain

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

File details

Details for the file agent_brain_cli-10.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_brain_cli-10.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d55738a879c27da1fd90406929c8fed2d0c775aaac289cde09140ec6c84d9b61
MD5 1dd09c95eaca48df924444829a8b2123
BLAKE2b-256 49da9599a859fda27cd1d6e654def4f0ac6e3f42f4e501f640a7d81df544a77f

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_brain_cli-10.3.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on SpillwaveSolutions/agent-brain

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page