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

# クイックスタート

> 環境をセットアップして BRICKS プロジェクトを作成する

## 前提条件

* [Bun](https://bun.sh) v1.3 以降
* [Git](https://git-scm.com)（強く推奨）
* [BRICKS](https://bricks.tools) ワークスペースアカウント

## プロジェクトの作成

bricks-ctor プロジェクトを取得する方法は 3 通りあります。

### オプション 1：BRICKS Controller（推奨）

[BRICKS Controller](/ja/controller/applications) の Web インターフェースからプロジェクトを生成します：

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)** をクリック

ワークスペースのセットアップ、Foundation のバインディング、アプリケーション管理については [BRICKS Controller ドキュメント](/ja/controller) を参照してください。

アーカイブを展開して実行します：

```bash theme={null}
cd my-app
bun install
```

### オプション 2：CLI

BRICKS CLI をインストールしてコマンドラインから初期化します：

```bash theme={null}
bun add -g @fugood/bricks-cli
bricks auth login
bricks app project-init <application-id> --yes
```

`project-init` コマンドはプロジェクトファイルを生成し、依存関係をインストールします。フラグで出力をカスタマイズできます：

| フラグ                   | 説明                         |
| --------------------- | -------------------------- |
| `--no-agents`         | AGENTS.md の生成をスキップ         |
| `--no-claude`         | CLAUDE.md の生成をスキップ         |
| `--gemini`            | GEMINI.md を含める             |
| `--no-github-actions` | GitHub Actions ワークフローをスキップ |

### オプション 3：CTOR

[CTOR](/ja/ctor) を使用します — AI エージェントが統合されたデスクトップ IDE で、チャットを通じてプロジェクトの作成・編集・デプロイが可能です。

## 開発ワークフロー

### コンパイル

TypeScript の型チェックを実行し、BRICKS ランタイムが使用する JSON 設定にコンパイルします：

```bash theme={null}
bun compile
```

### プレビュー

ローカルプレビューを起動してアプリをテストします：

```bash theme={null}
bun preview
```

プレビューはローカルウィンドウでアプリを開きます。`--show-menu` を使用すると追加のテストオプションが利用できます。

### デプロイ

コンパイル済みのアプリを [BRICKS](https://bricks.tools) サーバーにデプロイします：

```bash theme={null}
bun deploy-app
```

| フラグ                        | 説明                       |
| -------------------------- | ------------------------ |
| `--changelogs <text>`      | リリースの更新履歴テキスト            |
| `--changelogs-file <path>` | ファイルから更新履歴を読み込む          |
| `--auto-commit`            | デプロイ前に未ステージの変更を自動コミット    |
| `--auto-version`           | デプロイ前にパッチバージョンを自動インクリメント |
| `--version <version>`      | リリースのバージョンを明示的に指定        |
| `-y, --yes`                | すべての確認プロンプトをスキップ         |

バージョン解決の優先順位：`--version` フラグ > `--auto-version` インクリメント > `package.json` バージョン。`--version` と `--auto-version` はいずれもデプロイ前に `package.json` を更新します。

<Warning>
  デプロイにはクリーンな Git ワーキングツリーが必要です。デプロイ前に変更をコミットするか、`--auto-commit` を使用して自動的にコミットしてください。
</Warning>

### プル

サーバーからアプリケーションの最新バージョンをプルします：

```bash theme={null}
bun pull-app
```

このコマンドはローカルプロジェクトをサーバーバージョンと同期します。`--force` を使用するとローカルの変更を上書きします。

## AI 支援開発

bricks-ctor は AI コーディングエージェントと連携するよう設計されています。AI 指示を有効にしてプロジェクトを生成すると、次のファイルが作成されます：

| ファイル        | 使用者                  |
| ----------- | -------------------- |
| `CLAUDE.md` | Claude Code、CTOR     |
| `AGENTS.md` | Codex CLI、その他のエージェント |
| `GEMINI.md` | Gemini CLI           |

これらのファイルには、AI エージェントがアプリケーションを理解・修正するためのプロジェクト固有の指示、アーキテクチャパターン、BRICKS のドメイン知識が含まれています。

プロジェクトには [内蔵 MCP server](/ja/ctor-pkg/mcp-server) と [内蔵 skill](/ja/ctor-pkg/skills) も含まれており、AI エージェントにツールとドメイン知識を提供します。

<Tip>
  [CTOR](/ja/ctor) を使用すると、AI エージェントチャット、デプロイ、プレビューがすべて一つのアプリに統合された完全な体験を得られます。
</Tip>

## GitHub Actions を使用した CI/CD

プロジェクト生成時に GitHub Actions を有効にした場合、リポジトリには自動デプロイのワークフローが含まれます。メインブランチにプッシュするとデプロイがトリガーされます。