#NocoBase CLI

#説明

NocoBase CLI（nb）は NocoBase のコマンドラインエントリーポイントです。ローカルワークスペースでの初期化、接続、NocoBase アプリケーションの管理に使用します。

以下の 2 つの一般的な初期化パスをサポートしています：

• 既存の NocoBase アプリケーションに接続し、CLI env として保存する
• Docker、npm、または Git で新しい NocoBase アプリケーションをインストールし、CLI env として保存する

新しいローカルアプリケーションを作成する際、nb init は NocoBase AI coding skills のインストールまたは更新も行います。このステップをスキップするには、--skip-skills を使用してください。

#使い方

nb [command]

ルートコマンド自体は主にヘルプの表示に使用され、コマンドグループまたは個別のコマンドに呼び出しを振り分けます。

#コマンドグループ（Topics）

nb --help で以下のコマンドグループが表示されます：

#コマンド（Commands）

現在ルートコマンドが直接公開している個別コマンド：

#ヘルプの表示

ルートコマンドのヘルプを表示：

nb --help

特定のコマンドやコマンドグループのヘルプを表示：

nb init --help
nb app --help
nb api resource --help

#使用例

インタラクティブな初期化：

nb init

ブラウザフォームで初期化：

nb init --ui

非インタラクティブで Docker アプリケーションを作成：

nb init --env app1 --yes --source docker --version alpha

既存のアプリケーションに接続：

nb env add app1 --api-base-url http://localhost:13000/api

アプリケーションを起動してランタイムコマンドを更新：

nb app start -e app1
nb env update app1

API を呼び出す：

nb api resource list --resource users -e app1

#環境変数

以下の環境変数が CLI の動作に影響します：

使用例：

export NB_CLI_ROOT=/your/workspace
export NB_LOCALE=zh-CN

#設定ファイル

デフォルトの設定ファイル：

~/.nocobase/config.json

NB_CLI_ROOT=/your/workspace を設定した場合、設定ファイルのパスは次のようになります：

/your/workspace/.nocobase/config.json

CLI は現在の作業ディレクトリにある旧プロジェクト設定の読み取りにも対応しています。

ランタイムコマンドのキャッシュは以下に保存されます：

.nocobase/versions/<hash>/commands.json

このファイルは nb env update によって生成または更新され、ターゲットアプリケーションから同期されたランタイムコマンドをキャッシュするために使用されます。

#関連リンク

• クイックスタート
• インストール、アップグレード、マイグレーション
• グローバル環境変数
• AI ビルダー
• プラグイン開発