brainpalace-cli 26.5.1__tar.gz

brainpalace_cli-26.5.1/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.1
+Name: brainpalace-cli
+Version: 26.5.1
+Summary: BrainPalace CLI - Command-line interface for managing AI agent memory and knowledge retrieval
+Home-page: https://github.com/bxw91/brainpalace
+License: MIT
+Keywords: brainpalace,rag,cli,ai-memory,llm-memory,semantic-search,ai-agent,claude-code,agent-memory
+Author: bxw91
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: brainpalace-rag (>=26.5.1,<27.0.0)
+Requires-Dist: click (>=8.1.0,<9.0.0)
+Requires-Dist: httpx (>=0.28.0,<0.29.0)
+Requires-Dist: mcp (>=1.0,<2.0)
+Requires-Dist: pydantic (>=2.10.0,<3.0.0)
+Requires-Dist: pyyaml (>=6.0.0,<7.0.0)
+Requires-Dist: rich (>=13.9.0,<14.0.0)
+Project-URL: Documentation, https://github.com/bxw91/brainpalace#readme
+Project-URL: Repository, https://github.com/bxw91/brainpalace
+Description-Content-Type: text/markdown
+
+# 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.
+
+[![PyPI version](https://badge.fury.io/py/brainpalace-cli.svg)](https://pypi.org/project/brainpalace-cli/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## 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
+
+```bash
+pip install brainpalace-cli
+```
+
+## Quick Start
+
+```bash
+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
+
+```bash
+cd brainpalace-cli
+poetry install
+```
+
+## Usage
+
+```bash
+# 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:
+
+```bash
+export BRAINPALACE_URL=http://localhost:8000
+```
+
+Or use the `--url` flag:
+
+```bash
+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
+
+```bash
+# 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](https://github.com/bxw91/brainpalace/wiki/User-Guide) - Getting started and usage
+- [Developer Guide](https://github.com/bxw91/brainpalace/wiki/Developer-Guide) - Contributing and development
+- [API Reference](https://github.com/bxw91/brainpalace/wiki/API-Reference) - Full API documentation
+
+## Release Information
+
+- **Current Version**: See [pyproject.toml](./pyproject.toml)
+- **Release Notes**: [GitHub Releases](https://github.com/bxw91/brainpalace/releases)
+- **Changelog**: [Latest Release](https://github.com/bxw91/brainpalace/releases/latest)
+
+## Related Packages
+
+- [brainpalace-rag](https://pypi.org/project/brainpalace-rag/) - The RAG server that powers BrainPalace
+
+## License
+
+MIT
+

brainpalace_cli-26.5.1/README.md

@@ -0,0 +1,144 @@
+# 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.
+
+[![PyPI version](https://badge.fury.io/py/brainpalace-cli.svg)](https://pypi.org/project/brainpalace-cli/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## 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
+
+```bash
+pip install brainpalace-cli
+```
+
+## Quick Start
+
+```bash
+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
+
+```bash
+cd brainpalace-cli
+poetry install
+```
+
+## Usage
+
+```bash
+# 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:
+
+```bash
+export BRAINPALACE_URL=http://localhost:8000
+```
+
+Or use the `--url` flag:
+
+```bash
+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
+
+```bash
+# 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](https://github.com/bxw91/brainpalace/wiki/User-Guide) - Getting started and usage
+- [Developer Guide](https://github.com/bxw91/brainpalace/wiki/Developer-Guide) - Contributing and development
+- [API Reference](https://github.com/bxw91/brainpalace/wiki/API-Reference) - Full API documentation
+
+## Release Information
+
+- **Current Version**: See [pyproject.toml](./pyproject.toml)
+- **Release Notes**: [GitHub Releases](https://github.com/bxw91/brainpalace/releases)
+- **Changelog**: [Latest Release](https://github.com/bxw91/brainpalace/releases/latest)
+
+## Related Packages
+
+- [brainpalace-rag](https://pypi.org/project/brainpalace-rag/) - The RAG server that powers BrainPalace
+
+## License
+
+MIT

brainpalace_cli-26.5.1/brainpalace_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Doc-Serve CLI - Command-line interface for managing Doc-Serve server."""
+
+__version__ = "26.5.1"

brainpalace_cli-26.5.1/brainpalace_cli/cli.py

@@ -0,0 +1,131 @@
+"""Main CLI entry point for brainpalace CLI.
+
+This module provides the command-line interface for managing and querying
+the BrainPalace RAG server.
+"""
+
+import click
+
+from . import __version__
+from .commands import (
+    cache_group,
+    config_group,
+    context_command,
+    doctor_command,
+    folders_group,
+    index_command,
+    init_command,
+    inject_command,
+    install_agent_command,
+    jobs_command,
+    list_command,
+    mcp_command,
+    memories_group,
+    query_command,
+    recall_command,
+    remember_command,
+    reset_command,
+    start_command,
+    status_command,
+    stop_command,
+    submit_session_command,
+    types_group,
+    uninstall_command,
+    whoami_command,
+)
+
+
+@click.group()
+@click.version_option(version=__version__, prog_name="brainpalace")
+def cli() -> None:
+    """BrainPalace CLI - Manage and query the BrainPalace RAG server.
+
+    A command-line interface for interacting with the BrainPalace document
+    indexing and semantic search API.
+
+    \b
+    Project Commands:
+      init     Initialize a new brainpalace project
+      start    Start the server for this project
+      stop     Stop the server for this project
+      list     List all running brainpalace instances
+
+    \b
+    Server Commands:
+      status   Check server status
+      query    Search documents
+      index    Index documents from a folder
+      inject   Index documents with content injection
+      jobs     View and manage job queue
+      reset    Clear all indexed documents
+
+    \b
+    Cache Commands:
+      cache    Manage the embedding cache (status, clear)
+
+    \b
+    Folder Commands:
+      folders  Manage indexed folders (list, add, remove)
+
+    \b
+    File Type Commands:
+      types    List available file type presets
+
+    \b
+    MCP (Model Context Protocol):
+      mcp      Serve BrainPalace over stdio for MCP-aware AI clients
+
+    \b
+    Examples:
+      brainpalace init                                # Initialize project
+      brainpalace start                               # Start server
+      brainpalace status                              # Check server status
+      brainpalace query "how to use python"           # Search documents
+      brainpalace index ./docs                        # Index documents
+      brainpalace index ./src --include-type python   # Index with preset
+      brainpalace inject --script enrich.py ./docs   # Index with injection
+      brainpalace folders list                        # List indexed folders
+      brainpalace folders remove ./docs --yes         # Remove folder chunks
+      brainpalace types list                          # Show file type presets
+      brainpalace stop                                # Stop server
+
+    \b
+    Environment Variables:
+      BRAINPALACE_URL  Server URL (default: http://127.0.0.1:8000)
+    """
+    pass
+
+
+# Register project management commands
+cli.add_command(init_command, name="init")
+cli.add_command(start_command, name="start")
+cli.add_command(stop_command, name="stop")
+cli.add_command(list_command, name="list")
+cli.add_command(whoami_command, name="whoami")
+
+# Register server interaction commands
+cli.add_command(doctor_command, name="doctor")
+cli.add_command(status_command, name="status")
+cli.add_command(query_command, name="query")
+cli.add_command(remember_command, name="remember")
+cli.add_command(recall_command, name="recall")
+cli.add_command(memories_group, name="memories")
+cli.add_command(context_command, name="context")
+cli.add_command(submit_session_command, name="submit-session")
+cli.add_command(index_command, name="index")
+cli.add_command(inject_command, name="inject")
+cli.add_command(jobs_command, name="jobs")
+cli.add_command(reset_command, name="reset")
+cli.add_command(config_group, name="config")
+cli.add_command(folders_group, name="folders")
+cli.add_command(types_group, name="types")
+cli.add_command(cache_group, name="cache")
+cli.add_command(uninstall_command, name="uninstall")
+cli.add_command(install_agent_command, name="install-agent")
+
+# Register MCP server (opt-in stdio shim for non-Claude-Code AI clients)
+cli.add_command(mcp_command, name="mcp")
+
+
+if __name__ == "__main__":
+    cli()

brainpalace_cli-26.5.1/brainpalace_cli/client/__init__.py

@@ -0,0 +1,20 @@
+"""HTTP client for communicating with BrainPalace server."""
+
+from .api_client import (
+    ConnectionError,
+    DocServeClient,
+    DocServeError,
+    FolderInfo,
+    ServerError,
+)
+from .errors import EXIT_CODE_CONNECTION_ERROR, exit_on_connection_error
+
+__all__ = [
+    "DocServeClient",
+    "DocServeError",
+    "ConnectionError",
+    "EXIT_CODE_CONNECTION_ERROR",
+    "FolderInfo",
+    "ServerError",
+    "exit_on_connection_error",
+]