• 日本語

      • nb init

      現在のワークスペースを初期化し、coding agent が NocoBase に接続して使用できるようにします。nb init は既存のアプリケーションに接続することも、Docker、npm、または Git で新しいアプリケーションをインストールすることもできます。

      使い方

      nb init [flags]

      説明

      nb init は 3 つのプロンプトモードをサポートしています：

      • デフォルトモード：ターミナルでステップごとに入力します。
      • --ui：ローカルブラウザフォームでガイドフローを完了します。
      • --yes：プロンプトをスキップしてデフォルト値を使用します。このモードでは --env <envName> を指定する必要があり、新しいローカルアプリケーションが作成されます。

      デフォルトでは、nb init は初期化時または初期化の再開時に NocoBase AI coding skills をインストールまたは更新します。すでに skills を自己管理している場合や、CI・オフライン環境で実行する場合は、--skip-skills でこのステップをスキップできます。

      env 設定の保存後に初期化が中断された場合は、--resume で続行できます：

      nb init --env app1 --resume

      パラメータ

      パラメータ型説明
      --yes, -ybooleanプロンプトをスキップし、flags とデフォルト値を使用します
      --env, -estring今回の初期化の env 名。--yes および --resume モードでは必須です
      --uibooleanブラウザのビジュアルウィザードを開きます。--yes とは併用できません
      --verboseboolean詳細なコマンド出力を表示します
      --skip-skillsboolean初期化時の NocoBase AI coding skills のインストールまたは更新をスキップします
      --ui-hoststring--ui ローカルサーバーのバインドアドレス。デフォルトは 127.0.0.1 です
      --ui-portinteger--ui ローカルサーバーのポート。0 で自動割り当てです
      --localestringCLI プロンプトと UI の言語：en-US または zh-CN
      --api-base-url, -ustringNocoBase API アドレス。/api プレフィックスを含みます
      --auth-type, -astring認証方式：token または oauth
      --access-token, -tstringtoken 認証方式で使用する API key または access token
      --resumeboolean保存済みの workspace env config を再利用して初期化を続行します
      --lang, -lstringインストール後の NocoBase アプリケーションの言語
      --force, -fboolean既存の env を再設定し、必要に応じて競合する実行リソースを置き換えます
      --app-root-pathstringローカル npm/Git アプリケーションのソースディレクトリ。デフォルトは ./<envName>/source/ です
      --app-portstringローカルアプリケーションのポート。デフォルトは 13000。--yes モードでは空きポートが自動選択されます
      --storage-pathstringアップロードファイルとホストデータベースのデータディレクトリ。デフォルトは ./<envName>/storage/ です
      --root-usernamestring初期管理者ユーザー名
      --root-emailstring初期管理者メールアドレス
      --root-passwordstring初期管理者パスワード
      --root-nicknamestring初期管理者ニックネーム
      --builtin-db, --no-builtin-dbbooleanCLI 管理の組み込みデータベースを作成するかどうか
      --db-dialectstringデータベースの種類：postgres、mysql、mariadb、kingbase
      --builtin-db-imagestring組み込みデータベースのコンテナイメージ
      --db-hoststringデータベースホスト
      --db-portstringデータベースポート
      --db-databasestringデータベース名
      --db-userstringデータベースユーザー
      --db-passwordstringデータベースパスワード
      --fetch-sourcebooleanインストール前にアプリケーションファイルのダウンロードまたは Docker イメージの pull を行います
      --source, -sstringNocoBase の取得方法：docker、npm、または git
      --version, -vstringバージョンパラメータ：npm バージョン、Docker イメージ tag、または Git ref
      --replace, -rbooleanターゲットディレクトリが既に存在する場合に置き換えます
      --dev-dependencies, -Dbooleannpm/Git インストール時に devDependencies もインストールするかどうか
      --output-dir, -ostringダウンロード先ディレクトリ、または Docker tarball の保存ディレクトリ
      --git-urlstringGit リポジトリの URL
      --docker-registrystringDocker イメージリポジトリ名（tag を含まない）
      --docker-platformstringDocker イメージプラットフォーム：auto、linux/amd64、linux/arm64
      --docker-save, --no-docker-savebooleanDocker イメージを pull した後に tarball として保存するかどうか
      --npm-registrystringnpm/Git のダウンロードおよび依存関係のインストールに使用する registry
      --build, --no-buildbooleannpm/Git の依存関係インストール後にビルドを行うかどうか
      --build-dtsbooleannpm/Git ビルド時に TypeScript 宣言ファイルを生成するかどうか

      使用例

      nb init
nb init --ui
nb init --env app1 --yes
nb init --env app1 --yes --skip-skills
nb init --env app1 --resume
nb init --env app1 --resume --skip-skills
nb init --env app1 --yes --source docker --version alpha
nb init --env app1 --yes --source npm --version alpha --app-port 13080
nb init --env app1 --yes --source git --version fix/cli-v2
nb init --ui --ui-port 3000

      関連コマンド