Skip to content

Installation

The Coalex SDKs are available for Python and TypeScript:

  • Python SDK -- published on PyPI as coalex
  • TypeScript SDK -- published on npm as @coalex-ai/sdk

Requirements

Requirement Version
Python 3.11+
pip 21.0+ (or any PEP 517 installer)
Requirement Version
Node.js 18+
npm / pnpm 9+ / 8+

Core dependencies

The base install pulls in the following packages:

  • opentelemetry-sdk -- OpenTelemetry tracing core
  • opentelemetry-exporter-otlp-proto-http -- OTLP/HTTP exporter for sending traces
  • httpx -- HTTP client for the evaluate/resolve API

The base install pulls in the following packages:

  • @opentelemetry/api -- OpenTelemetry API
  • @opentelemetry/sdk-trace-node -- OpenTelemetry tracing for Node.js
  • @opentelemetry/exporter-trace-otlp-http -- OTLP/HTTP exporter for sending traces
  • @opentelemetry/resources -- OpenTelemetry resource attributes
  • @opentelemetry/semantic-conventions -- OpenTelemetry semantic conventions

Install methods

Base install

Install the core SDK with trace export and the evaluate/resolve API:

pip install coalex

This gives you coalex.register(), coalex.declare_agent(), coalex.coalex_context(), coalex.get_prompt(), coalex.evaluate(), coalex.resolve(), and all extension decorators. You handle LLM instrumentation manually or bring your own OpenTelemetry setup.

npm install @coalex-ai/sdk

This gives you register(), declareAgent(), coalexContext(), evaluate(), resolve(), and all extension wrapper functions. You handle LLM instrumentation manually or bring your own OpenTelemetry setup.

Auto-instrument all frameworks

Install with support for all 15 auto-instrumentable LLM frameworks:

pip install coalex[auto-instrument]

Install the SDK and the OpenInference instrumentor packages you need:

npm install @coalex-ai/sdk @arizeai/openinference-instrumentation-openai

Recommended for most users

This is the easiest way to get started. It installs instrumentors for every supported framework so auto_instrument() / autoInstrument() works out of the box.

Framework-specific extras

If you want to minimize dependencies, install only the extras for the frameworks you use:

pip install coalex[openai]

pip install coalex[anthropic]

pip install coalex[langchain]

pip install coalex[llamaindex]

pip install coalex[google-genai]

pip install coalex[vertexai]

pip install coalex[bedrock]

You can combine multiple extras:

pip install coalex[openai,langchain,vertexai]

Supported frameworks

The full list of frameworks supported by auto_instrument():

Framework Extra name
OpenAI openai
Anthropic anthropic
LangChain langchain
LlamaIndex llamaindex
Google Generative AI (Gemini) google-genai
Google Vertex AI vertexai
Amazon Bedrock bedrock
Mistral AI auto-instrument
Groq auto-instrument
CrewAI auto-instrument
Haystack auto-instrument
LiteLLM auto-instrument
DSPy auto-instrument
Instructor auto-instrument
Guardrails AI auto-instrument

Note

Frameworks listed with auto-instrument as their extra name are only available via the full coalex[auto-instrument] install. Individual extras are provided for the most commonly used frameworks.

Development install from source

To install the SDK from source for local development:

# Clone the monorepo
git clone https://github.com/coalex-ai/coalex.git
cd coalex

# Install with uv (recommended)
uv pip install -e "packages/sdk-python[auto-instrument,dev]"

Using uv

The Coalex monorepo uses uv as its Python package manager. If you do not have uv installed:

curl -LsSf https://astral.sh/uv/install.sh | sh

To run tests after installing from source:

cd packages/sdk-python
uv run pytest -v

# Clone the monorepo
git clone https://github.com/coalex-ai/coalex.git
cd coalex

# Install dependencies with pnpm
pnpm install

# Build the SDK
cd packages/sdk-typescript
pnpm build

To run tests after installing from source:

cd packages/sdk-typescript
pnpm test

Verifying your installation

After installing, verify the SDK is available:

import coalex
print(coalex.__version__)  # e.g. "1.9.0"

import { register } from "@coalex-ai/sdk";
console.log("@coalex-ai/sdk imported successfully");

You can also check that the OTLP exporter is configured correctly:

import coalex

coalex.register(
    api_key="your-api-key",
    service_name="install-check",
)

print("Coalex SDK configured successfully.")

import { register } from "@coalex-ai/sdk";

register({
    apiKey: "your-api-key",
    serviceName: "install-check",
});

console.log("Coalex SDK configured successfully.");

Next step

Head to the Quickstart to send your first traces.