Installation

There are variety of automated and manual methods for installing Quilkin onto your system. For cloud deployments Quilkin provides a container image to make it easily to immediately start using it. You can also install Quilkin on your local machine through Cargo.

Distributions

OCI Image

Source / Method

# A release.
docker pull ghcr.io/embarkstudios/quilkin:<version>
# A specific commit built from `main`.
docker pull ghcr.io/embarkstudios/quilkin:<short_commit>

Notes

Pre-built Quilkin binary with no preset arguments. Releases are tagged YYYY.M.PATCH and latest; builds from main are tagged with the commit's short SHA, such as 41673c8.

Cargo

Source / Method

cargo install --git https://github.com/EmbarkStudios/quilkin --tag v<version> quilkin

Notes

Compiled from source using cargo. Quilkin is not published to crates.io, so this installs from the Git tag.