Skip to content
kix /docs
Install the CLI

How-to guide Start and inspect a Kix project

Install and run the Kix CLI

Install Kix with Nix and verify that the CLI is available.

This guide assumes that Nix is installed with flakes enabled.

Install the kix package from the public kixpkgs flake:

❱ nix profile install github:kix-run/kixpkgs#kix

Nix adds the executable to your user profile. Open a new shell if the current one does not find it immediately.

Ask Kix for its version:

❱ kix --version
kix 0.1.0

Then confirm that the command list is available:

❱ kix --help

Kix evaluates the flake in the current directory unless you pass --flake. From a Kix project, a useful first command is:

kix-examples/
❱ kix list clusters

If the project is elsewhere, point Kix at it explicitly:

❱ kix --flake /path/to/project list clusters