nb source download

Obtém o NocoBase a partir do npm, Docker ou Git. --version é o parâmetro de versão compartilhado entre as três origens: para npm é a versão do pacote, para Docker é a tag da imagem e para Git é a git ref.

Uso

nb source download [flags]

Parâmetros

ParâmetroTipoDescrição
--yes, -ybooleanUsa os valores padrão e pula os prompts interativos
--verbosebooleanExibe a saída detalhada do comando
--localestringIdioma dos prompts do CLI: en-US ou zh-CN
--source, -sstringOrigem: docker, npm ou git
--version, -vstringVersão do pacote npm, tag da imagem Docker ou git ref
--replace, -rbooleanSubstitui o diretório de destino quando ele já existir
--dev-dependencies, -D / --no-dev-dependenciesbooleanDefine se devDependencies serão instaladas durante a instalação npm/Git
--output-dir, -ostringDiretório de destino do download, ou diretório onde o tarball Docker será salvo
--git-urlstringURL do repositório Git
--docker-registrystringNome do repositório de imagens Docker, sem a tag
--docker-platformstringPlataforma da imagem Docker: auto, linux/amd64, linux/arm64
--docker-save / --no-docker-savebooleanDefine se a imagem Docker será salva como tarball após o pull
--npm-registrystringRegistry usado para download e instalação de dependências npm/Git
--build / --no-buildbooleanDefine se o build será executado após a instalação de dependências npm/Git
--build-dtsbooleanDefine se arquivos de declaração TypeScript serão gerados durante o build npm/Git
--hook-scriptstringMódulo hook executado após npm scaffold ou Git clone e antes da instalação de dependências; só se aplica a source npm/Git

Exemplos

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 antes da instalação

--hook-script afeta apenas a execução atual de nb source download. Se você quiser que o hook seja salvo com o env e reutilizado por nb app upgrade ou restauração local de source, passe-o por nb init --hook-script.

O arquivo hook deve exportar um objeto como default e implementar beforeDependencyInstall(context):

export default {
  beforeDependencyInstall: async ({ sourcePath, version, envConfig }) => {
    // Executa após git clone / npm scaffold e antes de yarn install.
  },
};

Quando você executa nb source download --hook-script diretamente, beforeDependencyInstall recebe context.phase como source-download e context.command como source:download. Esse comando não executa beforeAppInstall nem afterAppStart; esses hooks pertencem aos fluxos de instalação, start, restart e upgrade da app.

Aliases de versão

Na origem Git, dist-tags comuns são resolvidos para os respectivos branches: latestmain, betanext, alphadevelop.

Comandos relacionados