Skip to main content

​
Prerequisites

​
Create a project

There are three ways to get a BRICKS project. Generate a project from the BRICKS Controller web interface:
  1. Open your application in BRICKS Controller
  2. Click Generate Project
  3. Configure options:
    • AGENTS.md — AI agent instructions (for Claude Code, Codex, etc.)
    • CLAUDE.md — Claude Code-specific instructions
    • GEMINI.md — Gemini CLI instructions
    • GitHub Actions — CI/CD deployment workflows
  4. Click Download Project (.zip)
See the BRICKS Controller docs for workspace setup, Foundation binding, and application management. Extract the archive and run:

​
Option 2: CLI

Install the BRICKS CLI, then initialize a project from the command line:
The bricks ctor init command generates the project files and installs dependencies. You can customize the output with flags:

​
Option 3: CTOR

Use CTOR — a desktop IDE with an integrated AI agent that can create, edit, and deploy projects through chat.

​
Development workflow

​
Compile

Type-check and compile your TypeScript into the JSON configuration the BRICKS runtime uses:
This runs bricks ctor compile under the hood.

​
Simulator

Launch your app in the local Simulator window:
This runs bricks ctor simulator. For the equivalent inside CTOR’s integrated IDE, see the embedded preview.

​
Deploy

Deploy your compiled app to the BRICKS server:
This runs bricks ctor deploy --auto-commit. Version resolution priority: --version flag > --auto-version bump > package.json version. Both --version and --auto-version update package.json before deploying.
Deployment requires a clean Git working tree. Commit your changes before deploying, or use --auto-commit to commit automatically.

​
Push without a release

Compile the current configuration and push it to the active stage without creating a release:
This runs bricks ctor push --auto-commit.

​
Pull

Pull the latest version of your application from the server:
This runs bricks ctor pull, performing a three-way Git merge between your local project and the server version. Use --force to overwrite local changes.

​
Migrate an existing project

Projects created with the older @fugood/bricks-ctor npm package migrate automatically the next time bun install runs, provided the BRICKS CLI 2.25.0 or later is installed globally. During migration:
  • Project scripts are rewritten to call bricks ctor commands
  • The @fugood/bricks-ctor dependency is removed
  • The local ctor/ library, MCP configuration, and skills are regenerated
To trigger the migration manually, run:

​
AI-assisted development

bricks-ctor is designed to work with AI coding agents. When you generate a project with AI instructions enabled, the following files are created: These files contain project-specific instructions, architecture patterns, and BRICKS domain knowledge that help AI agents understand and modify your application. The BRICKS CLI also delivers a built-in MCP server and built-in skills that provide tools and domain knowledge for AI agents working with your project.
Use CTOR for a fully integrated experience with AI agent chat, deployment, and preview — all in one app.

​
CI/CD with GitHub Actions

If you enabled GitHub Actions during project generation, your repository includes workflows for automated deployment. Push to your main branch to trigger a deploy.