Referência da CLI do Dataform

Este documento descreve os comandos da interface de linha de comando (CLI) do Dataform de código aberto.

Comandos da CLI do Dataform

A CLI do Dataform de código aberto oferece comandos para inicializar, compilar, testar e executar o Dataform Core localmente, fora do Google Cloud.

Comando da CLI do Dataform Descrição
dataform help Mostra a ajuda de todos os comandos da CLI do Dataform.
dataform help [command] Mostra a ajuda do comando especificado.
dataform init [project-dir] [default-database] [default-location] Cria um novo projeto do Dataform.
dataform install [project-dir] Instala as dependências do NPM para o projeto do Dataform especificado.
dataform init-creds [project-dir] Cria um arquivo .df-credentials.json para o Dataform usar ao acessar Google Cloud APIs.
dataform compile [project-dir] Compila o projeto do Dataform especificado e imprime um resumo do gráfico de dependência compilado sem executá-lo no BigQuery. Transmita --json ou --dot para saída JSON ou Graphviz DOT.
dataform test [project-dir] Executa os testes de unidade do projeto do Dataform especificado no BigQuery.
dataform run [project-dir] Executa os scripts do projeto do Dataform especificado no BigQuery.
dataform format [project-dir] Formata os arquivos do projeto do Dataform especificado.
--help Mostra a ajuda [boolean].
--version Mostra o número da versão da CLI do Dataform [boolean].

Opções e exemplos de comandos

Para conferir a lista completa de flags específicas do comando, flags de substituição de configuração de projeto compartilhadas e exemplos de uso, consulte a referência da CLI do Dataform no GitHub.