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

# Install Liza CLI on macOS, Linux, and Windows (WSL2)

> Install the Liza CLI on macOS or Linux in seconds using the install script, or build from source with Go 1.25.5 or later. All install paths covered.

Liza ships as a single statically linked binary for macOS and Linux. The install script handles platform detection, downloads the correct release artifact, and places the binary in your preferred directory. If you need a specific version, want to build from a branch, or prefer to compile from source, all three paths are covered below.

## System Requirements

Before installing, confirm your environment meets these requirements:

| Requirement | Details |
| - | - |
| **Operating system** | macOS or Linux. On Windows, use WSL2 — native Windows is not supported. |
| **Git** | 2.38 or later (required for git worktree support). |
| **Coding agent CLI** | At least one of: Claude Code, Codex, OpenCode, Kimi, Mistral, or Gemini. Claude and Codex are recommended. |
| **ripgrep (`rg`)** | Used by contracts and skills as the default code search tool. |
| **Go 1.25.5+** | Only required when building from source. Pre-built binaries do not need Go. |

> [!WARNING]
>
> **Windows:** Native Windows (PowerShell, CMD, Git Bash) is not supported. The install script will exit with an error if it detects a Windows environment. Use WSL2 and run all Liza commands from the WSL2 shell.

## Quick Install

The fastest way to install Liza is with the install script. It detects your OS and CPU architecture, downloads the latest release binary, and installs it to `~/.local/bin`:

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/liza-mas/liza/main/install.sh | bash
```

If `~/.local/bin` is not in your `PATH`, the script will print the exact line to add to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.).

## Install Options

Use environment variables to control what the script installs and where it puts it.

```bash Specific version theme={null}
curl -fsSL https://raw.githubusercontent.com/liza-mas/liza/main/install.sh | VERSION=v1.0.0 bash
```

```bash Build from a branch (requires Go and make) theme={null}
curl -fsSL https://raw.githubusercontent.com/liza-mas/liza/main/install.sh | BRANCH=main bash
```

```bash Custom install directory theme={null}
curl -fsSL https://raw.githubusercontent.com/liza-mas/liza/main/install.sh | INSTALL_DIR=~/.local/bin bash
```

```bash Combined options theme={null}
curl -fsSL https://raw.githubusercontent.com/liza-mas/liza/main/install.sh | VERSION=v1.0.0 INSTALL_DIR=/usr/local/bin bash
```

| Variable | Default | Description |
| - | - | - |
| `VERSION` | Latest release | Pin to a specific release tag, e.g. `v1.0.0`. |
| `BRANCH` | — | Build and install from a git branch. Requires Go 1.25.5+ and `make`. |
| `INSTALL_DIR` | `~/.local/bin` | Directory where the `liza` binary is placed. |

> [!NOTE]
>
> When you set `BRANCH`, the script clones the repository into a temporary directory, builds the binary with `make install`, and cleans up. This path requires Go 1.25.5+ and `make` to be available in your `PATH`.

## Install from Source

If you want full control over the build, clone the repository and use the Makefile directly:

```bash theme={null}
git clone https://github.com/liza-mas/liza.git
cd liza
make install
```

By default, `make install` places the binary in `~/.local/bin`. Override the destination:

```bash theme={null}
make install INSTALL_DIR=/usr/local/bin
```

**Requirements for source builds:**

* Go 1.25.5 or later — [download from go.dev](https://go.dev/dl/)
* `make`
* `git`

## Verify the Installation

After any install method, confirm the binary is reachable and working:

```bash theme={null}
liza version
```

You should see the version number, build commit, and target platform. If you get a "command not found" error, ensure the install directory is in your `PATH` and open a new terminal session.

## Upgrading

Re-run the install script to upgrade to the latest release:

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/liza-mas/liza/main/install.sh | bash
```

After upgrading, refresh your global Liza files to pick up any contract, skill, or pipeline changes:

```bash theme={null}
liza setup --force
```

> [!TIP]
>
> Pass the same provider flags you used during your original setup: `liza setup --force --claude --codex`. This ensures provider-specific integrations are also updated.

## Next Steps

With Liza installed, run `liza setup` to write the behavioral contract and configure your providers, then `liza init` inside your project to activate Liza there.

> [card] [Quickstart](https://lizamas.mintlify.site/quickstart.md)
>
> Step-by-step: setup, project init, and your first session.

> [card] [CLI Reference](https://lizamas.mintlify.site/reference/cli.md)
>
> Full documentation for every `liza` command and flag.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.