Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getbindu.com/llms.txt

Use this file to discover all available pages before exploring further.

The install step should be boring. Two commands, no surprises.

​
The short path: uv

uv add bindu
That’s it. If you don’t have uv yet: 
curl -LsSf https://astral.sh/uv/install.sh | sh
Restart your shell, then uv add bindu. You need Python 3.12 or newer.

​
The pip path

If you’d rather use a standard venv: 
python3 -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate
pip install -U bindu
If pip install fails, the usual culprit is an old pip. Run python -m pip install --upgrade pip and retry.

​
API keys

To run anything interesting you’ll need a key for at least one LLM provider: 
# Pick one — agents in the examples folder use these
OPENAI_API_KEY=sk-...
OPENROUTER_API_KEY=sk-or-...
MINIMAX_API_KEY=...
Put them in a .env file at the project root. The examples all use python-dotenv to load it.

​
Verify it worked

uv run python -c "import bindu; print(bindu.__version__)"
You should see a version string (PyPI releases are 0.3.x; source checkouts use CalVer like 2026.21.x.devN+g<sha>). Either way, if it prints, Bindu imported cleanly — head to Your first agent.

​
Hacking on Bindu itself

Different goal — you want to contribute to the framework, not just use it: 
git clone https://github.com/getbindu/Bindu.git
cd Bindu
uv sync --dev
pre-commit run --all-files
The full contributor guide lives at .github/contributing.md. Most of the day-to-day chat happens on Discord — come say hi.