Install and run the Kix CLI

This guide assumes that Nix is installed with flakes enabled.

Install Kix

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.

Verify the installation

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:

Run in kix-examples/

❱ kix list clusters

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

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

Try it as a tutorial

Work through local setup and your first Kix deployment to create a kind cluster and run the complete edit, check, deploy, and verify loop.