Introdução ao Netlify CLI

A CLI (Command Line Interface) do Netlify permite que você faça deploy, execute build, além de poder executar um servidor de desenvolvimento local que pode ser compartilhado por uma URL (Uniform Resource Locator).

Instalação

Para instalar o Netlify CLI é necessário ter a versão 10 ou superior do Node.js.

npm install -g netlify-cli

Uma vez instalado globalmente, você pode executar o comando abaixo em qualquer diretório para obter a versão e informação básica sobre a ferramenta.

netlify

Autenticação

Netlify CLI usa um token de acesso para se autenticar com o Netlify. Você pode obter o token usando a linha de comando ou pelo Netlify UI.

Obtendo um token com a linha de comando

Para se autenticar e obter um token de acesso usando a linha de comando, execute o comando abaixo em qualquer diretório:

netlify login

O comando acima vai abrir uma guia no navegador solicitando que você acesse sua conta e dê permissão ao Netlify CLI.

Uma vez autorizado, o Netlify CLI armazena o token de acesso em um arquivo de configuração global config.json. O Netlify CLI usa automaticamente o token armazenado para todos os comandos executados futuramente.

Localização do config.json

Você pode encontrar o arquivo de configuração global do Netlify CLI, config.json, em uma das localizações abaixo:

• Linux: .config/netlify/config.json
• Windows: AppData\Roaming\netlify\Config\config.json
• macOS: Library/Preferences/netlify/config.json

Obtendo um token pelo Netlify UI

Para gerar um token de acesso pelo Netlify UI, acesse o caminho abaixo:

Netlify > User Settings > Applications > OAuth > Personal access token

Em seguida, clique em Generate token, após isso, copie o token, crie uma variável de ambiente chamada NETLIFY_AUTH_TOKEN e adicione o token gerado.

Cancelando o token de acesso

O cancelamento do token de acesso gerado pelo Netlify CLI e pelo Netlify UI pode ser realizado pelo caminho abaixo:

Netlify > User Settings > Applications > OAuth

Os tokens gerados pelo Netlify CLI podem ser encontrados em Authorized applications e os tokens gerados pelo Netlify UI podem ser encontrados em Personal access tokens.

Inicializando um repositório

Para conectar repositórios armazenados no GitHub, você pode executar o comando abaixo no seu repositório local:

netlify init

Quando você executar o comando acima, será solicitado que você acesse a conta do GitHub, onde será criado um token de acesso no nível da conta.

Para uma configuração manual ou liberar acesso somente para um repositório clique aqui.

Executando um ambiente de desenvolvimento local

Antes de usar o Netlify Dev, você deve estar autenticado e ter certeza que seu site está associado a um siteID. Você pode fazer isso com netlify init ou com netlify link.

Para iniciar um servidor de desenvolvimento local, execute o comando abaixo na raiz do repositório.

netlify dev

Compartilhando um servidor de desenvolvimento

Para compartilhar um servidor de desenvolvimento local por uma URL, execute o comando abaixo.

netlify dev --live

Para cessar a documentação do Netlify Dev clique aqui.

Deploy manual

É possível fazer deploy do seu site manualmente, sem continuous deployment. Este método envia os arquivos diretamente do diretório do projeto local para o seu site no Netlify.

Para iniciar um deploy manual, execute o comando abaixo:

netlify deploy

Na primeira vez que você executar o comando, o Netlify CLI vai perguntar qual o site deseja selecionar ou se deseja criar um novo, associando o site para futuros deploys.

Diretório do deploy

O comando deploy precisa saber qual pasta publicar. Se seu projeto inclui Serverless Functions, também será necessário informar a pasta das functions. O Netlify CLI vai procurar por estas informações em três lugares, conforme abaixo:

• Nas flags informadas no comando.
• No arquivo netlify.toml armazenado na raiz do diretório do seu projeto.
• Nas configurações do Netlify UI.

Abaixo há um exemplo usando flags para configurar a pasta a ser publicada e também a pasta das functions:

netlify deploy --dir=_site --functions=functions

Deploys de produção e de rascunho

Por padrão, o comando deploy vai publicar em uma URL de rascunho exclusiva para visualização e teste.

Para fazer um deploy de produção na URL do seu site principal, use a flag --prod ou a versão curta -p.

netlify deploy --prod

Associar e desassociar sites

Se você quer conectar o seu repositório ou projeto local a um site no Netlify, você pode pular os passos inicias acima e executar o comando abaixo na raiz do diretório local.

netlify link

Dessa forma será adicionado um campo siteId a um novo arquivo dentro da pasta do projeto, em .netlify/state.json. Para desassociar sua pasta do site, você pode remover o campo adicionado ou executar o comando abaixo dentro da pasta do projeto.

netlify unlink

Associar com uma variável de ambiente

É possível associar um site com o ID no Netlify UI, para isso, adicione o ID nas variáveis de ambiente.

1. Vá para Site settings > General > Site details > Site information e copie o valor de API ID.
2. Crie uma variável de ambiente chamada NETLIFY_SITE_ID e insira o valor do ID.

Exibindo as mensagens de depuração

Para exibir as mensagens de depuração, configure a variável DEBUG antes de executar um comando, conforme o sistema operacional.

Linux: DEBUG=* netlify deploy

Windows: /set DEBUG=* & netlify deploy

Windows PowerShell: $env:DEBUG='*';netlify deploy

Comando help

Para obter dicas e aprender mais sobre os comandos disponíveis do Netlify CLI, execute o comando abaixo:

netlify help

Para mais informações sobre um comando específico, execute help com o nome do comando.

netlify help deploy

Isso também funciona para sub-comandos.

netlify help sites:create