> For the complete documentation index, see [llms.txt](https://docs.pipekit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pipekit.io/reference/cli/install.md).

# Install

Install via your platform's package manager, or grab a precompiled binary from the [Pipekit CLI releases page](https://github.com/pipekit/cli/releases).

## macOS & Linux (Homebrew)

```bash
brew install pipekit/tap/cli
```

* [Homebrew homepage](https://brew.sh/)

## Windows (Scoop)

```bash
scoop bucket add pipekit https://github.com/pipekit/scoop.git
scoop install pipekit/cli
```

* [Scoop homepage](https://scoop.sh/)

## NixOS & Nix

Install from nixpkgs:

```bash
nix profile install nixpkgs#pipekit
```

In a NixOS or home-manager configuration:

```nix
environment.systemPackages = [ pkgs.pipekit ];
```

{% hint style="info" %}
The Pipekit CLI is proprietary, so the Nix derivation is marked `unfree`. Set `NIXPKGS_ALLOW_UNFREE=1` before installing, or allow the package in your NixOS or home-manager configuration via `nixpkgs.config.allowUnfreePredicate`.
{% endhint %}

### Bleeding-edge channel

The nixpkgs entry updates after each CLI release lands a maintainer-reviewed bump PR, so it lags the GitHub release by a few days. To install the newest CLI release immediately, use the interim flake:

```bash
nix profile install github:pipekit/pipekit-nix
```

* [Nix homepage](https://nixos.org/)
* [`pipekit/pipekit-nix` source](https://github.com/pipekit/pipekit-nix)

## Docker container

A Wolfi-based Docker image ships with each CLI release. Pull `pipekit13/cli:<tag>` and run it:

```bash
docker run \
  -e PIPEKIT_USERNAME=myusername \
  -e PIPEKIT_PASSWORD=mypassword \
  pipekit13/cli \
  pipekit login && \
  pipekit list clusters
```

The `latest` tag is pinned to the latest released version of the Pipekit CLI. (To find a specific version, [check the tags on Docker Hub](https://hub.docker.com/r/pipekit13/cli/tags).)

Containers are available in `linux/amd64` and `linux/arm64` variants. Both use [Wolfi](https://github.com/wolfi-dev) Linux as the base image.

For more involved container patterns (copying the CLI into your own image, embedding it in a Workflow), see [Advanced > Docker container](/reference/cli/advanced.md#docker-container).

## Software Bill of Materials (SBOM)

An SBOM for the CLI container is embedded within the container image in SPDX format. For extraction commands and signing verification, see [Why Pipekit > Security > Software Bill of Materials](/why-pipekit/security.md#software-bill-of-materials-sbom).

## Verify the install

```bash
pipekit --version
```

If you don't see a version string, check that the install directory is on your `PATH`.

## What's next

* [Log in](/reference/cli/commands.md#log-in) and start submitting Workflows.
* For Hera workflows, see [Using with Hera](/reference/cli/using-with-hera.md).