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

# Installation

> Install the ProofRail SDK and the framework adapters you need

# Installation

ProofRail ships as a Python package, installed directly from GitHub until the PyPI release lands. Install the core SDK, then add framework-specific extras for whichever orchestration tools you use.

## Requirements

* Python 3.10 or later
* A ProofRail account and API key — sign up at [proofrail.dev](https://proofrail.dev)

## Core SDK

```bash theme={null}
pip install git+https://github.com/TOAAiV/proofrail
```

This installs the framework-agnostic `Chain` context manager, the policy engine, payload sanitization, and the backend HTTP client. Use this directly if you're orchestrating agents yourself.

## Framework adapters

ProofRail ships adapters for the most-used agent frameworks. Install only what you need.

<CodeGroup>
  ```bash LangGraph theme={null}
  pip install "proofrail[langgraph] @ git+https://github.com/TOAAiV/proofrail"
  ```

  ```bash LangChain theme={null}
  pip install "proofrail[langchain] @ git+https://github.com/TOAAiV/proofrail"
  ```

  ```bash CrewAI theme={null}
  pip install "proofrail[crewai] @ git+https://github.com/TOAAiV/proofrail"
  ```

  ```bash MCP theme={null}
  pip install "proofrail[mcp] @ git+https://github.com/TOAAiV/proofrail"
  ```

  ```bash All adapters theme={null}
  pip install "proofrail[all] @ git+https://github.com/TOAAiV/proofrail"
  ```
</CodeGroup>

Each extra installs the framework itself if not already present, plus any framework-specific helpers ProofRail uses.

<Note>
  Framework version compatibility is documented per adapter. See [Framework Integration](/frameworks/langgraph) for the pinned ranges. Supported version ranges are pinned in `sdk/pyproject.toml`; install with a compatible framework version in your environment.
</Note>

## Verify your install

```python theme={null}
import proofrail
print(proofrail.__version__)
```

Should print the installed version (e.g., `0.1.0`).

## Get your API key

Sign up at [proofrail.dev](https://proofrail.dev). After verifying your email, create an API key from the dashboard. Keys are prefixed with `prail_` and shown once at creation — store yours in a secrets manager or `.env` file.

```bash theme={null}
# .env
PROOFRAIL_API_KEY=prail_your_key_here
```

## Initialize the SDK

```python theme={null}
import os
import proofrail

proofrail.init(api_key=os.environ["PROOFRAIL_API_KEY"])
```

That's the minimum. The SDK has many configuration options for tuning behavior — see [Configuration Reference](/reference/configuration) for the full surface.

## What's next

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    First governed chain in under 10 minutes.
  </Card>

  <Card title="Configuration" icon="gear" href="/reference/configuration">
    Every `init()` parameter, explained.
  </Card>
</CardGroup>