Skip to main content

​
Prerequisites

  • Bun v1.3 or later
  • Git (strongly recommended)
  • A BRICKS workspace account

​
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: 
cd my-app
bun install

​
Option 2: CLI

Install the BRICKS CLI and initialize from the command line: 
bun add -g @fugood/bricks-cli
bricks auth login
bricks app project-init <application-id> --yes
The project-init command generates the project files and installs dependencies. You can customize the output with flags:
FlagDescription
--no-agentsSkip AGENTS.md generation
--no-claudeSkip CLAUDE.md generation
--geminiInclude GEMINI.md
--no-github-actionsSkip GitHub Actions workflows

​
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: 
bun compile

​
Preview

Launch a local preview to test your app: 
bun preview
The preview opens your app in a local window. Use --show-menu for additional testing options.

​
Deploy

Deploy your compiled app to the BRICKS server: 
bun deploy-app
FlagDescription
--changelogs <text>Changelogs text for the release
--changelogs-file <path>Read changelogs from a file
--auto-commitAuto-commit unstaged changes before deploying
--auto-versionAuto-bump patch version before deploying
--version <version>Set explicit version for the release
-y, --yesSkip all prompts
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.

​
Pull

Pull the latest version of your application from the server: 
bun pull-app
This syncs your local project with the server version. Use --force to overwrite local changes.

​
AI-assisted development

BRICKS Project is designed to work with AI coding agents. When you generate a project with AI instructions enabled, the following files are created:
FileUsed by
CLAUDE.mdClaude Code, CTOR
AGENTS.mdCodex CLI, other agents
GEMINI.mdGemini CLI
These files contain project-specific instructions, architecture patterns, and BRICKS domain knowledge that help AI agents understand and modify your application. The project also includes a built-in MCP server and a built-in skill 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.