nb source download

npm、Docker、または Git から NocoBase を取得します。--version は 3 つの source で共通のバージョンパラメータです。npm ではパッケージバージョン、Docker ではイメージ tag、Git では git ref を指定します。

使い方

nb source download [flags]

パラメータ

パラメータ説明
--yes, -ybooleanデフォルト値を使用し、インタラクティブプロンプトをスキップします
--verboseboolean詳細なコマンド出力を表示します
--localestringCLI プロンプトの言語:en-US または zh-CN
--source, -sstring取得方法:dockernpm、または git
--version, -vstringnpm パッケージバージョン、Docker イメージ tag、または Git ref
--replace, -rbooleanターゲットディレクトリが既に存在する場合に置き換えます
--dev-dependencies, -D / --no-dev-dependenciesbooleannpm/Git インストール時に devDependencies もインストールするかどうか
--output-dir, -ostringダウンロード先ディレクトリ、または Docker tarball の保存ディレクトリ
--git-urlstringGit リポジトリの URL
--docker-registrystringDocker イメージリポジトリ名(tag を含まない)
--docker-platformstringDocker イメージプラットフォーム:autolinux/amd64linux/arm64
--docker-save / --no-docker-savebooleanDocker イメージを pull した後に tarball として保存するかどうか
--npm-registrystringnpm/Git のダウンロードおよび依存関係のインストールに使用する registry
--build / --no-buildbooleannpm/Git の依存関係インストール後にビルドを行うかどうか
--build-dtsbooleannpm/Git ビルド時に TypeScript 宣言ファイルを生成するかどうか
--hook-scriptstringnpm scaffold または Git clone の後、依存関係インストールの前に実行する hook モジュール。npm/Git source にのみ適用されます

使用例

nb source download
nb source download -y --source npm --version alpha
nb source download -y --source npm --version alpha --no-build
nb source download --source npm --version alpha --output-dir=./app
nb source download --source docker --version alpha --docker-registry=nocobase/nocobase --docker-platform=linux/arm64
nb source download -y --source docker --version alpha --docker-save -o ./docker-images
nb source download --source git --version alpha --git-url=git@github.com:nocobase/nocobase.git
nb source download --source git --version fix/cli-v2
nb source download -y --source npm --version alpha --build-dts
nb source download -y --source npm --version alpha --npm-registry=https://registry.npmmirror.com
nb source download -y --source git --version beta --hook-script ./hooks.mjs

インストール前 hook

--hook-script は現在の nb source download 実行にのみ影響します。hook を env と一緒に保存し、nb app upgrade やローカル source の復元で再利用したい場合は、代わりに nb init --hook-script で渡してください。

hook ファイルはオブジェクトを default export し、beforeDependencyInstall(context) を実装する必要があります:

export default {
  beforeDependencyInstall: async ({ sourcePath, version, envConfig }) => {
    // git clone / npm scaffold の後、yarn install の前に実行されます。
  },
};

nb source download --hook-script を直接実行した場合、beforeDependencyInstall には context.phasesource-downloadcontext.commandsource:download として渡されます。このコマンドは beforeAppInstallafterAppStart を実行しません。これらの hook はアプリの install、start、restart、upgrade フローに属します。

バージョンエイリアス

Git source の場合、よく使われる dist-tag は対応するブランチに解決されます:latest -> mainbeta -> nextalpha -> develop

関連コマンド