Skip to main content

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.

​
Requirements

CTOR depends on a few command-line tools to run projects, install dependencies, and talk to your workspace:
ToolMinimum versionStatusPurpose
BRICKS CLI2.24.0RequiredAgent workflows that interact with your BRICKS workspace
Bun1.3.0RequiredJavaScript runtime for installing dependencies and running scripts
Git—RecommendedVersion control for project history
You also need a BRICKS 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.
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.

​
Manual install

If you would rather set things up from a terminal, the same installers are available as one-liners: 
# 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.

​
Download

Download the latest build for macOS (Apple Silicon):

Download for macOS (ARM64)

CTOR-arm64.dmg
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.

​
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.
Download the latest macOS beta build (Apple Silicon):

Download CTOR Beta for macOS (ARM64)

CTOR-Beta-arm64.dmg
Open the DMG and drag CTOR Beta to your Applications folder.

​
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

Log in to your workspace

Authenticate with your BRICKS workspace to start building.