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

# Installation

> Download and install BRICKS CLI

BRICKS CLI ships as a native standalone executable for macOS, Linux, and Windows. No Node.js runtime is required. If you prefer, you can also install it from npm or Bun.

## Install

<Tabs>
  <Tab title="macOS">
    ```bash theme={null}
    curl -fsSL https://cdn.bricks.tools/bricks-cli/release/install.sh | sh
    ```

    The script detects your architecture (Apple Silicon or Intel), downloads the native binary to `~/.local/bin/bricks`, and makes it executable.

    If `~/.local/bin` is not on your `PATH`, add this to your shell profile:

    ```bash theme={null}
    export PATH="$HOME/.local/bin:$PATH"
    ```
  </Tab>

  <Tab title="Linux">
    ```bash theme={null}
    curl -fsSL https://cdn.bricks.tools/bricks-cli/release/install.sh | sh
    ```

    The script detects your architecture (x86\_64 or ARM64) and C library (glibc or musl), downloads the native binary to `~/.local/bin/bricks`, and makes it executable.

    If `~/.local/bin` is not on your `PATH`, add this to your shell profile:

    ```bash theme={null}
    export PATH="$HOME/.local/bin:$PATH"
    ```
  </Tab>

  <Tab title="Windows">
    Run in PowerShell:

    ```powershell theme={null}
    irm https://cdn.bricks.tools/bricks-cli/release/install.ps1 | iex
    ```

    The script detects your architecture (x64 or ARM64) and installs `bricks.exe` to `%LOCALAPPDATA%\Programs\bricks-cli\bin\`.

    If the install directory is not on your user `PATH`, the script prints the command to add it. You can also add it from **Settings** > **System** > **About** > **Advanced system settings** > **Environment Variables**.
  </Tab>

  <Tab title="npm / Bun">
    The CLI is also published on npm. This method requires **Node.js 22+** or **Bun**.

    ```bash theme={null}
    # npm
    npm install -g @fugood/bricks-cli

    # Bun
    bun add -g @fugood/bricks-cli
    ```
  </Tab>
</Tabs>

## Verify

```bash theme={null}
bricks --version
```

If the command is not found, confirm that your install directory is on your `PATH` and restart your terminal.

## Beta channel

Install the beta channel alongside the stable release. The beta binary is named `bricks-beta`, so both channels can coexist.

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    curl -fsSL https://cdn.bricks.tools/bricks-cli/beta/install.sh | sh -s -- --beta
    ```

    Run it with:

    ```bash theme={null}
    bricks-beta --version
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    irm https://cdn.bricks.tools/bricks-cli/beta/install.ps1 -OutFile install-beta.ps1
    .\install-beta.ps1 -Beta
    ```

    Run it with:

    ```powershell theme={null}
    bricks-beta --version
    ```
  </Tab>
</Tabs>

## Update

Run `bricks update-cli` to update an existing install in-place. It auto-detects how the CLI was installed (npm, Bun, or standalone binary) and runs the matching update command. See [`bricks update-cli`](/cli/commands#bricks-update-cli) in the command reference.

```bash theme={null}
bricks update-cli         # prompts before updating
bricks update-cli -y      # non-interactive
```

## Uninstall

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    # Stable
    curl -fsSL https://cdn.bricks.tools/bricks-cli/release/uninstall.sh | sh

    # Beta
    curl -fsSL https://cdn.bricks.tools/bricks-cli/beta/uninstall.sh | sh -s -- --beta
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    # Stable
    irm https://cdn.bricks.tools/bricks-cli/release/uninstall.ps1 | iex

    # Beta
    irm https://cdn.bricks.tools/bricks-cli/beta/uninstall.ps1 -OutFile uninstall-beta.ps1
    .\uninstall-beta.ps1 -Beta
    ```
  </Tab>

  <Tab title="npm / Bun">
    ```bash theme={null}
    # npm
    npm uninstall -g @fugood/bricks-cli

    # Bun
    bun remove -g @fugood/bricks-cli
    ```
  </Tab>
</Tabs>

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/cli/authentication">
    Log in with a passcode and manage workspace profiles.
  </Card>

  <Card title="Command reference" icon="book" href="/cli/commands">
    Full reference for every CLI command and option.
  </Card>
</CardGroup>