Installation¶

Requirements¶

Python 3.14 or newer
A running FalkorDB instance or falkordblite for embedded testing without an external server

pip install runic-py

With uv (recommended):

uv add runic-py

Verify the installation:

runic --help

You should see the runic help text listing all available commands.

runic talks to FalkorDB via the official falkordb Python client, which is declared as a direct dependency and installed automatically.

For a quick local FalkorDB instance with Docker:

docker run -p 6379:6379 falkordb/falkordb

For integration testing without an external server, install falkordblite:

uv add --dev falkordblite

See Testing Migrations for how to use the embedded server in your test suite.

Clone the repository and install all dev dependencies:

git clone https://github.com/jenreh/runic
cd runic
uv sync --all-groups