> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heyniblet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the Niblet CLI

> Install a checksum-verified release on macOS or Linux, or build the CLI from source.

The `niblet` executable is the local authoring toolkit and Pixlet-compatible runtime. It can create projects, serve live previews, validate Starlark, render WebP or GIF output, authenticate, and upload immutable app revisions.

## macOS and Linux

```sh theme={null}
curl -fsSL https://raw.githubusercontent.com/commacollectivehq/niblet-pixlet/main/scripts/install.sh | sh
```

The installer detects the operating system and CPU architecture, downloads the matching release, verifies its SHA-256 checksum, and installs `niblet` in `/usr/local/bin`. If `pixlet` is not already present, it also creates a compatibility symlink.

If `/usr/local/bin` is not writable, choose another directory already on your `PATH`:

```sh theme={null}
curl -fsSL https://raw.githubusercontent.com/commacollectivehq/niblet-pixlet/main/scripts/install.sh | \
  NIBLET_INSTALL_DIR="$HOME/.local/bin" sh
```

## Verify the install

```sh theme={null}
niblet version
niblet --help
```

## Build from source

Install Go, Node.js, and libwebp, then run:

```sh theme={null}
git clone https://github.com/commacollectivehq/niblet-pixlet.git
cd niblet-pixlet
npm --prefix frontend ci
npm --prefix frontend run build
make build
```

Copy the resulting `niblet` binary into a directory on your `PATH`.

<Note>
  The release installer currently supports macOS and Linux. Windows developers can build the Pixlet-compatible runtime from source; a signed Niblet Windows installer is not yet part of the release path.
</Note>