> ## Documentation Index
> Fetch the complete documentation index at: https://www.botgauge.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the SDK

> Install the BotGauge Python SDK with pip, add framework extras with botgauge setup, and pin versions in requirements.txt. Requires Python 3.10 or newer.

```bash terminal theme={null}
# the SDK and the botgauge command
pip install botgauge

# tracing for the frameworks your app uses: finds them, installs their extras
botgauge setup --install
```

`pip install botgauge` installs the tracing SDK and the `botgauge` command. It depends only on OpenTelemetry. On its own it records the turns, agents, and spans your own code creates. It does not install tracing for every framework BotGauge supports, so you add only what your app uses.

The package requires Python 3.10 or newer.

## Framework extras

Each extra adds the instrumentation that records one framework's LLM calls (model, prompts, token counts) and tool calls.

`botgauge setup --install` finds the frameworks installed in your environment without importing them, then installs the BotGauge extra for each one at your installed BotGauge version. It uses `pip`, or `uv` in an environment created by `uv venv`. To preview without installing anything, run `botgauge setup --detect`.

You can also name an extra yourself, for example in `requirements.txt`. This installs LangChain tracing with the versions BotGauge verified.

```bash terminal theme={null}
pip install "botgauge[langchain]" \
  langchain==1.4.6 langgraph==1.2.16 langchain-openai==1.7.2
```

| Extra | Framework |
| - | - |
| `langchain` | LangChain |
| `langgraph` | LangGraph |
| `openai` | OpenAI SDK |
| `anthropic` | Anthropic SDK |
| `llamaindex` | LlamaIndex |
| `crewai` | CrewAI |
| `openai-agents` | OpenAI Agents |
| `google-adk` | Google ADK |
| `autogen-agentchat` | AutoGen AgentChat |
| `pydantic-ai` | PydanticAI |
| `mcp` | MCP |

You can combine extras in one install, for example `pip install "botgauge[mcp,openai]"`. The [supported frameworks](https://www.botgauge.com/docs/integrations/overview.md) page lists the framework versions BotGauge verified with each extra.

## Verify the installation

```bash terminal theme={null}
botgauge doctor
```

`botgauge doctor` prints a read-only report of the current process: the tracer provider, active instrumentors, and any warnings. Add `--json` for machine-readable output. See the [CLI reference](https://www.botgauge.com/docs/reference/cli.md) for every command.

Install the SDK from your projectStart in [BotGauge](https://cloud.botgauge.com) to get your API key and then install the package with pip.

[Try BotGauge →](https://cloud.botgauge.com)

## Next step

[Manual tracing](https://www.botgauge.com/docs/tracing/manual-tracing.md) shows how to wrap turns and agents in code. If you'd rather not edit your app, go to [zero-code instrumentation](https://www.botgauge.com/docs/tracing/zero-code.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.