Installation

It is recommended to use uv to install Python packages, which is an extremely fast Python package and project manager.

GA packages

Install package with only fundamental dependencies.

uv tool install --upgrade 'cratedb-toolkit'

Install package including all subsystems / full dependencies.

uv tool install --upgrade 'cratedb-toolkit[all]'

Verify installation.

cratedb-toolkit --version

The package also installs a shortcut alias ctk.

ctk --version

Container

Alternatively, use the Docker image per ghcr.io/crate/cratedb-toolkit.

Run with Docker or Podman.

docker run --rm -it --pull=always "ghcr.io/crate/cratedb-toolkit" ctk --version

To conveniently use CrateDB Toolkit on your workstation without installing it.

alias ctk='docker run --rm -it --network=host "ghcr.io/crate/cratedb-toolkit" ctk'

Run on Kubernetes.

Todo

Add a quick description how to whip CTK into a K8s service unit.

Git

You can easily install the latest development version from the Git repository. This example command selects the cfr extra for demonstration purposes.

uv tool install 'cratedb-toolkit[cfr] @ git+https://github.com/crate/cratedb-toolkit'

Dependency / subsystem selection

To install subsets of dependencies selectively, please choose amongst the possible Python package “extras” that relate to corresponding subsystems: cfr, cloud, datasets, docs-api, dynamodb, influxdb, io, kinesis, mcp, mongodb, pymongo, service, testing.