> ## 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 CTOR

## Requirements

CTOR depends on a few command-line tools to run projects, install dependencies, and talk to your workspace:

| Tool                       | Minimum version | Status      | Purpose                                                            |
| -------------------------- | --------------- | ----------- | ------------------------------------------------------------------ |
| [BRICKS CLI](/cli)         | 2.24.0          | Required    | Agent workflows that interact with your BRICKS workspace           |
| [Bun](https://bun.sh)      | 1.3.0           | Required    | JavaScript runtime for installing dependencies and running scripts |
| [Git](https://git-scm.com) | —               | Recommended | Version control for project history                                |

You also need a [BRICKS](https://bricks.tools) workspace account to log in.

### Requirements screen

The first time you launch CTOR — and any time BRICKS CLI or Bun is missing or outdated — CTOR shows a **Setup Requirements** screen before the login page. Each tool gets a card with its detected version, the minimum required version, and an action button:

* **Install** — runs the official curl-based installer in the background and streams output into an expandable log. BRICKS CLI installs to `~/.bricks-cli/bin`; Bun installs to `~/.bun/bin`. CTOR re-checks automatically when the installer finishes.
* **Update** — appears when a tool is installed but below the minimum version. Re-runs the installer to pull the latest release.
* **Skip** — only available for Git, which is optional. Click **Skip** to dismiss the Git card without installing.
* **View Docs** — appears on Windows, where auto-install is not yet supported. Opens the upstream installer page.

Click **Re-check** to re-probe after a manual install, then **Continue** once every required tool reports satisfied.

<Info>
  Detection probes `~/.bricks-cli/bin`, `~/.bun/bin`, and the npm global prefix directly before falling back to `which`, so freshly installed binaries are picked up even if your shell's PATH has not been refreshed.
</Info>

### Manual install

If you would rather set things up from a terminal, the same installers are available as one-liners:

```bash theme={null}
# BRICKS CLI → ~/.bricks-cli/bin/bricks
curl -fsSL https://cdn.bricks.tools/bricks-cli/release/install.sh | sh

# Bun → ~/.bun/bin/bun
curl -fsSL https://bun.sh/install | bash
```

On macOS, run `xcode-select --install` to install Git via the Command Line Tools. On Linux, use your package manager (e.g. `apt install git`). On Windows, download Git from [git-scm.com](https://git-scm.com/downloads).

## Download

<Tabs>
  <Tab title="macOS">
    **Homebrew:**

    ```bash theme={null}
    brew install --cask mybigday/bricks/bricks-ctor
    ```

    **Manual download:**

    Download the latest build for macOS (Apple Silicon):

    <Card title="Download for macOS (ARM64)" icon="apple" href="https://cdn.bricks.tools/bricks-project-desktop/release/CTOR-arm64.dmg">
      CTOR-arm64.dmg
    </Card>

    Open the DMG and drag the app to your Applications folder. The app is notarized by Apple. On first launch, macOS may show a security prompt — click **Open** to proceed.
  </Tab>

  <Tab title="Linux">
    **Quick install:**

    ```bash theme={null}
    curl -fsSL https://cdn.bricks.tools/bricks-project-desktop/release/install.sh | sh
    ```

    The script auto-detects your architecture, downloads the AppImage to `~/.local/bin/bricks-ctor`, installs the `libfuse2` runtime dependency via your distro's package manager when missing, and optionally creates a desktop entry.

    To uninstall:

    ```bash theme={null}
    curl -fsSL https://cdn.bricks.tools/bricks-project-desktop/release/uninstall.sh | sh
    ```

    **Manual download:**

    <CardGroup cols={2}>
      <Card title="Linux (x86_64)" icon="linux" href="https://cdn.bricks.tools/bricks-project-desktop/release/CTOR-x86_64.AppImage">
        CTOR-x86\_64.AppImage
      </Card>

      <Card title="Linux (ARM64)" icon="linux" href="https://cdn.bricks.tools/bricks-project-desktop/release/CTOR-arm64.AppImage">
        CTOR-arm64.AppImage
      </Card>
    </CardGroup>

    ```bash theme={null}
    chmod +x CTOR-x86_64.AppImage
    ./CTOR-x86_64.AppImage
    ```

    <Note>
      The AppImage requires `libfuse2` (FUSE 2) at runtime. Many recent distros do not ship it by default. The quick-install script installs it automatically; for manual downloads, install it yourself:

      | Distro                    | Command                        |
      | ------------------------- | ------------------------------ |
      | Debian / Ubuntu (≤ 22.04) | `sudo apt install libfuse2`    |
      | Ubuntu 24.04+             | `sudo apt install libfuse2t64` |
      | Fedora / RHEL             | `sudo dnf install fuse-libs`   |
      | Arch                      | `sudo pacman -S fuse2`         |
      | openSUSE                  | `sudo zypper install libfuse2` |
      | Alpine                    | `sudo apk add fuse`            |
    </Note>
  </Tab>
</Tabs>

## Beta channel

Install the beta channel alongside the stable release. The beta app is named **CTOR Beta**, and the Linux binary is `bricks-ctor-beta`, so both channels can coexist.

<Tabs>
  <Tab title="macOS">
    **Homebrew:**

    ```bash theme={null}
    brew install --cask mybigday/bricks/bricks-ctor-beta
    ```

    **Manual download:**

    <Card title="Download CTOR Beta for macOS (ARM64)" icon="apple" href="https://cdn.bricks.tools/bricks-project-desktop/beta/CTOR-Beta-arm64.dmg">
      CTOR-Beta-arm64.dmg
    </Card>

    Open the DMG and drag **CTOR Beta** to your Applications folder.
  </Tab>

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

    The script installs the AppImage to `~/.local/bin/bricks-ctor-beta`. Run it with:

    ```bash theme={null}
    bricks-ctor-beta
    ```

    To uninstall:

    ```bash theme={null}
    curl -fsSL https://cdn.bricks.tools/bricks-project-desktop/beta/uninstall.sh | sh -s -- --beta
    ```
  </Tab>
</Tabs>

## Auto-updates

CTOR checks for updates automatically. When a new version is available:

1. Open **Settings** (gear icon)
2. Scroll to the **Updates** section
3. Click **Download & Install** to update in place

The app displays your current version and the latest available version in the settings panel.

## Next steps

<Card title="Log in to your workspace" icon="right-to-bracket" href="/ctor/guide/authentication">
  Authenticate with your BRICKS workspace to start building.
</Card>