Installation¶

Ginkgo targets Python 3.11+. Use the curl installer to get just the ginkgo CLI, or Pixi for a full local development setup.

Quick Install (curl)¶

Install the ginkgo CLI in one line. This requires uv:

curl -LsSf https://raw.githubusercontent.com/sanjaynagi/ginkgo/main/install.sh | sh

This installs ginkgo from main into an isolated environment via uv tool install. Re-run the same command to upgrade.

This repository already includes a Pixi workspace. Install the environment and use Pixi to run tests, the CLI, and the docs build.

pixi install
pixi run test
pixi run docs-build

If your workflows use Pixi-backed task environments, pixi must also be available on your PATH when you run those workflows.

If you prefer a plain Python environment:

pip install -e .

That installs the ginkgo console script defined in the project metadata.

Notebook tasks rely on optional dependencies:

If you are not using notebooks, you do not need those packages for basic workflow authoring or execution.

After installation, confirm that the CLI is available:

ginkgo --help

If you are using Pixi instead of installing the console script directly:

pixi run python -m ginkgo.cli --help