Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hexr.dev/llms.txt

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

The Hexr SDK is distributed from a private PyPI registry at pypi.hexr.cloud. You need to point your package manager at this registry when installing. If you use Hexr Cloud, hexr login configures this for you automatically — but you can also configure it manually for CI environments or local development.

​
Requirements

  • Python 3.10+
  • Access to the Hexr private PyPI registry (pypi.hexr.cloud)

​
Install

uv pip install "hexr-sdk[cli]" --extra-index-url https://pypi.hexr.cloud/simple/

​
Configure persistent registry access

To avoid passing --extra-index-url on every install command, add the registry to your package manager configuration: 
[global]
extra-index-url = https://pypi.hexr.cloud/simple/

​
Verify installation

python -c "import hexr; print(hexr.__version__)"
Expected output: 
0.2.7

​
What’s included

The hexr-sdk[cli] package bundles the core module and all optional modules. Each module brings its own lightweight dependencies:
ModuleDependencies
Core (hexr_agent, hexr_tool, hexr_llm)opentelemetry-api, opentelemetry-sdk, grpcio
hexr.vaulthttpx
hexr.gatewayhttpx
hexr.sandboxhttpx
hexr.browserhttpx
hexr.guardhttpx
hexr.a2ahttpx, pydantic
Core dependencies are minimal. Lazy-loaded modules only import their dependencies when first accessed, so importing hexr itself has minimal overhead.

​
Kubernetes deployments

When you run hexr deploy, the SDK is installed automatically via an init container — you do not need to add hexr to your agent’s requirements.txt: 
initContainers:
  - name: install-hexr-sdk
    image: python:3.11-slim
    command: ["pip", "install", "--target=/shared/site-packages", "hexr"]
    env:
      - name: PIP_INDEX_URL
        value: "https://pypi.hexr.cloud/simple/"
The init container injects the SDK into a shared volume mounted by your agent container. Your agent image stays lean and the SDK version is controlled by the platform.