SkeinRank installation

SkeinRank has two adoption paths:

• the lightweight Python SDK and CLI for dictionary validation, extraction, discovery, and canonicalization;
• the Docker beta stack for the governance console, API, PostgreSQL, Elasticsearch, RabbitMQ worker, and optional observability profile.

Looking for repository vocabulary and pull-request checks? Start with Agent Lexicon installation.

Requirements

Core SDK and CLI

• Python 3.10+

Platform beta

• Git
• Docker Compose V2
• enough local memory for PostgreSQL, Elasticsearch, RabbitMQ, the API, workers, and the web console

Install the core package

python -m pip install skeinrank

Verify the installation with the built-in demo dictionary:

python -c "import skeinrank; print(skeinrank.canonicalize('k8s pg timeout'))"

Expected output:

kubernetes postgresql timeout

Continue to the SkeinRank SDK quickstart.

Install from the repository

git clone https://github.com/SkeinRank/skeinrank.git
cd skeinrank/packages/skeinrank-core
poetry install
poetry run pytest -q

Run the platform beta with Docker

git clone https://github.com/SkeinRank/skeinrank.git
cd skeinrank
cp .env.example .env
docker compose -f docker-compose.dev.yml up --build -d

Then open:

http://127.0.0.1:5173

Read the full guide for auth, observability, reset commands, and troubleshooting:

Open Docker beta quickstart