AI Agent インストールガイド

このページは AI Agent(Claude Code、Codex、Cursor、Copilot など)向けの NocoBase CLI インストール・初期化ガイドです。

人間のユーザーの方は、クイックスタート をご参照ください。

Step 1:前提環境のチェック

ユーザーが以下の依存関係をインストール済みであることを確認します:

  • Node.js >= 22node -v を実行して確認)
  • Yarn 1.xyarn -v を実行して確認)。未インストールの場合は npm install -g yarn でインストール
  • Gitgit --version を実行して確認)。未インストールの場合は Git 公式サイト からインストール
  • Docker(ユーザーが Docker 方式で NocoBase をインストールする場合)。docker -v を実行して確認し、未インストールかつユーザーが Docker を使用する場合は Docker 公式サイト からのインストールを案内し、それ以外はスキップ。

前提環境を満たしていない場合は、不足している依存関係のインストールが必要であることをユーザーに伝え、インストールリンクと簡単なインストール手順を提供します。すべての前提環境が満たされていることを確認してから、次のステップに進みます。

Step 2:CLI のインストール

ユーザーの環境に NocoBase CLI がすでにインストールされている場合(nb --version で確認)、次のステップに進みます。未インストールの場合は、以下のコマンドを実行します:

npm install -g @nocobase/cli

nb --version を実行してインストールが成功したことを確認します。

Step 3:初期化コマンドの実行

⚠️ 重要:以下のコマンドを正確に実行してください。--ui パラメータを変更・置換・省略してはいけません。「非対話モード」で実行したり、パラメータを自分で組み立てて「高速化」しようとしないでください。--ui が唯一正しい初期化方法です。

nb init --ui

このコマンドはブラウザのビジュアルウィザードを起動します。ユーザーはブラウザですべての設定(インストール方式、データベース、管理者アカウントなど)を完了する必要があります。AI Agent としての役割は:

  1. nb init --ui のみを実行する -- 追加のパラメータは付けない
  2. ユーザーに伝える -- ブラウザが自動的にローカル設定ページを開くので、そこで設定を完了する必要がある
  3. ブラウザが自動的に開けない場合(サンドボックスの権限制限など)、コマンド出力の URL をユーザーに提供し、手動でブラウザにコピーして開くよう案内する
  4. ユーザーの確認を待つ -- 設定が完了したことを確認してから次のステップに進む。このコマンドにはデフォルトで 30 分のタイムアウトがあり、タイムアウト内はコマンドを繰り返し実行しない

Step 4:結果の検証

nb env list

出力に設定済みの環境と実行状態が表示されていることを確認します。その後、実行中の NocoBase インスタンスの URL をブラウザで開き、設定したアカウント・パスワードでログインできることをユーザーに案内します。

Step 5:完了

インストールが完了したことをユーザーに伝えます。CLI の設定はグローバルディレクトリ(デフォルト ~/.nocobase/)に保存されるため、AI Agent は任意のディレクトリからアクセスでき、特定の作業ディレクトリに移動する必要はありません。