Skip to main content

​
Installation

Install the Arclasp-compatible Python package used by Arclasp. Install the core SDK, then add framework-specific extras for whichever orchestration tools you use.

​
Requirements

  • Python 3.10 or later
  • An Arclasp account and API key — sign up at proofrail.dev

​
Core SDK

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

The SDK ships adapters for the most-used agent frameworks. Install only what you need.
Each extra installs the framework itself if not already present, plus any framework-specific helpers the SDK uses.
Installing from source instead. If you’re developing against an unreleased SDK change rather than doing normal customer onboarding, install directly from the source checkout: pip install -e . from the SDK repo root, or pip install git+https://github.com/TOAAiV/proofrail for a specific branch. This is a source-development alternative, not the standard onboarding path.
Framework version compatibility is documented per adapter. See Framework Integration for the pinned ranges. Supported version ranges are pinned in sdk/pyproject.toml; install with a compatible framework version in your environment.

​
Verify your install

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

​
Get your API key

Sign up at 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.

​
Initialize the SDK

backend_url defaults to http://localhost:8000 for local development. To reach hosted Arclasp, pass it explicitly:
That’s the minimum for hosted use. The SDK has many configuration options for tuning behavior — see Configuration Reference for the full surface.

​
What’s next

Quickstart

Your first governed, approved, and receipted action.

Configuration

Every init() parameter, explained.