Skip to content

Installation

kolinsky has no system dependencies: the crate builds with Cargo, the Python wheels and the command-line binaries are self-contained.

cargo add kolinsky
pip install kolinsky
v=$(curl -fsSL https://kolinsky.spenhouet.com/releases/latest.json | sed -n 's/.*"version": "\([^"]*\)".*/\1/p') && curl -fsSL "https://kolinsky.spenhouet.com/releases/v$v/kolinsky-$v-x86_64-unknown-linux-gnu.tar.gz" | tar xz && sudo mv "kolinsky-$v-x86_64-unknown-linux-gnu/kolinsky" /usr/local/bin/
v=$(curl -fsSL https://kolinsky.spenhouet.com/releases/latest.json | sed -n 's/.*"version": "\([^"]*\)".*/\1/p') && curl -fsSL "https://kolinsky.spenhouet.com/releases/v$v/kolinsky-$v-aarch64-unknown-linux-gnu.tar.gz" | tar xz && sudo mv "kolinsky-$v-aarch64-unknown-linux-gnu/kolinsky" /usr/local/bin/
v=$(curl -fsSL https://kolinsky.spenhouet.com/releases/latest.json | sed -n 's/.*"version": "\([^"]*\)".*/\1/p') && curl -fsSL "https://kolinsky.spenhouet.com/releases/v$v/kolinsky-$v-aarch64-apple-darwin.tar.gz" | tar xz && sudo mv "kolinsky-$v-aarch64-apple-darwin/kolinsky" /usr/local/bin/
v=$(curl -fsSL https://kolinsky.spenhouet.com/releases/latest.json | sed -n 's/.*"version": "\([^"]*\)".*/\1/p') && curl -fsSL "https://kolinsky.spenhouet.com/releases/v$v/kolinsky-$v-x86_64-apple-darwin.tar.gz" | tar xz && sudo mv "kolinsky-$v-x86_64-apple-darwin/kolinsky" /usr/local/bin/
$v = (irm https://kolinsky.spenhouet.com/releases/latest.json).version; irm "https://kolinsky.spenhouet.com/releases/v$v/kolinsky-$v-x86_64-pc-windows-msvc.zip" -OutFile kolinsky.zip; Expand-Archive kolinsky.zip -DestinationPath .

Platforms

Platform Command line Python wheel
Linux x86_64 (glibc) yes manylinux
Linux aarch64 (glibc) yes manylinux
Linux x86_64 (musl) build from source musllinux
macOS arm64 (Apple silicon) yes universal2
macOS x86_64 yes universal2
Windows x86_64 yes yes

The Python wheels are abi3 wheels: one wheel per platform for CPython 3.9 and every later version. The command-line archives come with a SHA256SUMS file next to them.

Building from source

The Rust crate is always built from source by Cargo; it needs a stable Rust toolchain and the C compiler Cargo finds by default (the TLS library of the HTTP client compiles a few C and assembly files), and no system libraries. Build your application with --release for real use; the timings on the benchmarks page are of release builds.

The Python package is also published as a source distribution. Where no wheel fits (another CPU, another C library), pip builds it from source, which needs a Rust toolchain (rustup); to force a source build:

pip install --no-binary kolinsky kolinsky

The command line is distributed as the prebuilt binaries above. On a platform without one, use the crate or the Python package.

Fonts

Fonts come from the system (fontconfig's directories on Linux and other Unix systems, the system and user font folders on macOS and Windows), from the document's @font-face rules and from folders you add with --font-dir. kolinsky fonts lists the faces it finds.