For the complete documentation index, see llms.txt. This page is also available as Markdown.

Install

Install the Pipekit CLI on macOS, Linux, Windows, and NixOS.

Install via your platform's package manager, or grab a precompiled binary from the Pipekit CLI releases page.

macOS & Linux (Homebrew)

brew install pipekit/tap/cli

Windows (Scoop)

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

NixOS & Nix

Install from nixpkgs:

nix profile install nixpkgs#pipekit

In a NixOS or home-manager configuration:

environment.systemPackages = [ pkgs.pipekit ];

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.

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:

Docker container

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

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.)

Containers are available in linux/amd64 and linux/arm64 variants. Both use Wolfi 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.

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.

Verify the install

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

What's next

Last updated