Skip to main content

前置需求

  • Bun v1.3 或更新版本
  • Git(強烈建議)
  • BRICKS CLI(2.25.0 或更新版本)
  • 一個 BRICKS 工作區帳號

建立專案

取得 bricks-ctor 專案有三種方式。

選項 1:BRICKS Controller(建議)

BRICKS Controller 網頁介面產生專案:
  1. 在 BRICKS Controller 中開啟您的應用程式
  2. 點擊 Generate Project
  3. 設定選項:
    • AGENTS.md —AI 代理指令(適用於 Claude Code、Codex 等)
    • CLAUDE.md —Claude Code 專用指令
    • GEMINI.md —Gemini CLI 指令
    • GitHub Actions —CI/CD 部署工作流程
  4. 點擊 Download Project (.zip)
請參閱 BRICKS Controller 文件,了解工作區設定、Foundation 綁定與應用程式管理。 解壓縮後執行:

選項 2:CLI

安裝 BRICKS CLI,然後從指令列初始化專案:
bricks ctor init 指令會產生專案檔案並安裝相依套件。您可以使用旗標自訂輸出:

選項 3:CTOR

使用 CTOR —一個內建 AI 代理的桌面 IDE,可透過對話建立、編輯和部署專案。

開發工作流程

編譯

對您的 TypeScript 檢查並編譯成 BRICKS 執行環境所需的 JSON 設定:
此指令底層會執行 bricks ctor compile

Simulator

在本機 Simulator 視窗中啟動您的應用程式:
此指令會執行 bricks ctor simulator。若要使用 CTOR 整合式 IDE 中的對應功能,請參閱內嵌預覽

部署

將已編譯的應用程式部署至 BRICKS 伺服器:
此指令會執行 bricks ctor deploy --auto-commit 版本解析優先順序:--version 旗標 > --auto-version 升版 > package.json 版本。--version--auto-version 都會在部署前更新 package.json
部署需要乾淨的 Git 工作目錄。請在部署前提交您的變更,或使用 --auto-commit 自動提交。

推送而不建立版本

編譯目前的設定並將其推送至目前的階段,但不建立版本:
此指令會執行 bricks ctor push --auto-commit

拉取

從伺服器拉取最新版本的應用程式:
此指令會執行 bricks ctor pull,在您的本機專案與伺服器版本之間進行三方 Git 合併。使用 --force 可覆蓋本機變更。

遷移現有專案

以舊版 @fugood/bricks-ctor npm 套件建立的專案,只要全域安裝了 BRICKS CLI 2.25.0 或更新版本,就會在下次執行 bun install 時自動遷移。遷移過程會:
  • 將專案指令碼改寫為呼叫 bricks ctor 指令
  • 移除 @fugood/bricks-ctor 相依套件
  • 重新產生本機 ctor/ 函式庫、MCP 設定與 skills
若要手動觸發遷移,請執行:

AI 輔助開發

bricks-ctor 的設計與 AI 編碼代理協同運作。當您在啟用 AI 指令的情況下產生專案時,會建立以下檔案: 這些檔案包含專案專屬指令、架構模式,以及協助 AI 代理理解和修改應用程式的 BRICKS 領域知識。 BRICKS CLI 也會設定內建 MCP server內建 skills,為 AI 代理提供工具與領域知識。
使用 CTOR 可享有完整整合體驗,包含 AI 代理對話、部署和預覽——全在同一個應用程式中。

使用 GitHub Actions 進行 CI/CD

若您在產生專案時啟用了 GitHub Actions,您的儲存庫中會包含自動部署的工作流程。推送至主分支即可觸發部署。