Install BuddhiAI CLI
Install the buddhi command with Python 3.10 or newer. Include the mcp extra if you also need the buddhi-mcp server.
Prerequisites
Section titled “Prerequisites”- Python: Version 3.10 or higher is required.
- Package Manager: One of
pip,pipx, oruv. - Operating System: The package is OS independent.
- MCP server: Install the
[mcp]extra to usebuddhi-mcp.
Verify your Python version:
python --version# Output should show Python 3.10.x or higherInstallation Methods
Section titled “Installation Methods”Method 1: Using pip (Standard Installation)
Section titled “Method 1: Using pip (Standard Installation)”You can install BuddhiAI CLI directly using pip. Be sure to include the [mcp] extra to install the Model Context Protocol server components:
pip install "buddhi-ai[mcp]"To upgrade an existing installation:
pip install --upgrade "buddhi-ai[mcp]"Method 2: Using pipx (Isolated Tool Environment)
Section titled “Method 2: Using pipx (Isolated Tool Environment)”If you prefer installing command-line tools in isolated virtual environments to prevent dependency conflicts across global packages:
pipx install "buddhi-ai[mcp]"To upgrade via pipx:
pipx upgrade buddhi-aiMethod 3: Using uv
Section titled “Method 3: Using uv”If you use Astral’s uv, install BuddhiAI CLI as an isolated tool:
uv tool install "buddhi-ai[mcp]"To upgrade via uv:
uv tool upgrade buddhi-aiInstalled Binaries
Section titled “Installed Binaries”Installing with [mcp] provisions two primary executable binaries in your PATH:
buddhi: The core command-line tool for project initialization, graph building, documentation planning, and Spec-Driven Development (SDD).buddhi-mcp: The standalone Stdio Model Context Protocol server entrypoint, allowing AI agents like Google Antigravity to interact with the code graph.
Verifying Installation
Section titled “Verifying Installation”Verify that both commands are accessible in your terminal:
# Verify the CLI toolbuddhi --help
# Verify the MCP entrypointbuddhi-mcp --helpThe help output lists the commands available in the installed version. For command details, see the CLI command reference.
Shell Auto-Completion
Section titled “Shell Auto-Completion”BuddhiAI CLI supports auto-completion for popular shells (Bash, Zsh, Fish, PowerShell):
buddhi --install-completionFollow the on-screen instructions to activate completion for your current shell.
Troubleshooting
Section titled “Troubleshooting”Command Not Found (buddhi: command not found)
Section titled “Command Not Found (buddhi: command not found)”Ensure that Python’s user bin directory is included in your system’s PATH environment variable:
- macOS / Linux:
~/.local/bin - Windows:
%USERPROFILE%\AppData\Roaming\Python\Python3xx\Scriptsoruvtool path%USERPROFILE%\.local\bin
Windows PowerShell Encoding Issue
Section titled “Windows PowerShell Encoding Issue”When executing shell automation scripts on Windows, ensure your terminal processes UTF-8 correctly by setting:
$env:PYTHONUTF8 = "1"Next Steps
Section titled “Next Steps”Now that BuddhiAI CLI is installed, learn how to initialize your projects in the Commands Reference.