Installation

Prerequisites

Python 3.11, 3.12, or 3.13.
An isolated environment created with venv, uv, Poetry, or an equivalent tool.
Docker, PostgreSQL, and Redis only for the complete server deployment.

pip
uv
Source

python -m venv .venv
# Linux/macOS
source .venv/bin/activate
# Windows PowerShell
.venv\Scripts\Activate.ps1

pip install lingxigraph

uv venv
uv pip install lingxigraph

git clone https://github.com/LingXi-Org/LingxiGraph.git
cd LingxiGraph
pip install -e ".[dev,all]"

Optional dependencies

The core package has no third-party runtime dependencies. Install only the extras your application needs:

Extra	Command	Includes
`server`	`pip install "lingxigraph[server]"`	FastAPI, Uvicorn, JWT, HTTP client
`sdk`	`pip install "lingxigraph[sdk]"`	Sync and async Python HTTP SDK
`postgres`	`pip install "lingxigraph[postgres]"`	PostgreSQL repository, checkpoints, Store
`redis`	`pip install "lingxigraph[redis]"`	Cache, PubSub, cancellation acceleration
`otel`	`pip install "lingxigraph[otel]"`	OpenTelemetry SDK and OTLP exporter
`coze`	`pip install "lingxigraph[coze]"`	Coze Bot, Workflow, and ChatModel
`openai`	`pip install "lingxigraph[openai]"`	OpenAI-compatible ChatModel
`all`	`pip install "lingxigraph[all]"`	Complete production feature set

Verify the installation

lingxigraph --version
python -c "from lingxigraph import StateGraph; print('LingxiGraph ready')"

lingxigraph dev requires the server extra. lingxigraph server also needs postgres when a PostgreSQL URL is configured. Project images built from the supplied Dockerfile include production dependencies.

Get started

Core concepts

Guides

API reference

Operations and project

Prerequisites

Optional dependencies

Verify the installation

Next step

Embedded runtime

Server runtime

​Prerequisites

​Optional dependencies

​Verify the installation

​Next step

Embedded runtime

Server runtime

Prerequisites

Optional dependencies

Verify the installation

Next step