Esta página foi traduzida pela API Cloud Translation.

Usar a interface de linha de comando com a clasp

Para desenvolver e gerenciar projetos do Apps Script no seu terminal, e não no editor, você pode usar uma ferramenta de código aberto chamada clasp.

O codelab do clasp (em inglês) oferece uma visão geral de todos os recursos do clasp.

Recursos

Desenvolvimento local

O clasp permite que você desenvolva seus projetos do Apps Script localmente. Escreva o código no seu computador e faça upload dele para o Apps Script quando terminar. Você também pode fazer o download de projetos existentes do Apps Script para editá-los quando estiver off-line. Como o código é local, você pode usar suas ferramentas de desenvolvimento favoritas, como o git, ao criar projetos do Apps Script.

Gerenciar versões de implantação

Criar, atualizar e ver as várias implantações do projeto.

Código da estrutura

clasp permite que você organize seu código em diretórios, que são preservados quando você faz upload deles para script.google.com. Por exemplo:

# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

# Locally:
├── tests/
│   ├─ slides.gs
│   └─ sheets.gs

Requisitos

clasp é escrito em Node.js e distribuído por meio da ferramenta npm. Antes de usar o clasp, é necessário ter o Node.js versão 4.7.4 ou posterior instalado. A instalação do Node.js exige privilégios de administrador.

Instalação

Depois de instalar o Node.js, use o seguinte comando npm para instalar o clasp:

npm install @google/clasp -g

Após a instalação, use o comando clasp em qualquer diretório no computador.

Como usar o `clasp`

Você pode usar o clasp para processar várias tarefas na linha de comando. Esta seção descreve operações comuns que você pode usar ao desenvolver com clasp.

Esse comando faz login e autoriza o gerenciamento dos projetos do Apps Script da sua Conta do Google. Após a execução, será solicitado que você faça login em uma Conta do Google em que seus projetos do Apps Script estão armazenados.

clasp login

Logout

Esse comando sai da ferramenta de linha de comando. Faça um novo login usando clasp login para se autenticar novamente com o Google antes de continuar usando o clasp.

clasp logout

Criar um novo projeto do Apps Script

Esse comando cria um novo script no diretório atual com um título de script opcional.

clasp create [scriptTitle]

Este comando também cria dois arquivos no diretório atual:

Um arquivo .clasp.json que armazena o ID do script.
Um arquivo de manifesto de projeto appsscript.json que contém os metadados do projeto.

Clone um projeto

Esse comando clona um projeto que está no diretório atual. O script precisa ser criado ou compartilhado com sua Conta do Google. Para especificar o projeto de script a ser clonado, forneça o ID do script.

Para encontrar o ID do script do projeto, siga as etapas abaixo:

Abra o projeto do Apps Script.
À esquerda, clique em Configurações do projeto .
Em IDs, copie o ID do script.
```
 clasp clone <scriptId>
```

Fazer o download de um projeto de script

Este comando faz o download do projeto do Apps Script do Google Drive para o sistema de arquivos do seu computador.

clasp pull

Fazer upload de um projeto de script

Esse comando faz o upload de todos os arquivos de um projeto de script do computador para o Google Drive.

clasp push

Listar versões do projeto

Esse comando lista o número e a descrição de cada uma das versões de um projeto de script.

clasp versions

Implantar um projeto publicado

É possível implantar projetos de script como apps da Web, complementos ou executáveis. É possível criar implantações no editor de script, no manifesto do projeto ou usando clasp.

Para implantar um projeto com clasp, primeiro crie uma versão imutável do projeto do Apps Script. Uma versão é um "snapshot" de um projeto de script e é semelhante a uma versão ramificada somente leitura.

clasp version [description]

Esse comando exibe o número da versão recém-criada. Com esse número, é possível implantar e cancelar a implantação de instâncias do projeto:

clasp deploy [version] [description]
clasp undeploy <deploymentId>

Este comando atualiza uma implantação atual com uma nova versão e descrição:

clasp redeploy <deploymentId> <version> <description>

Listar implantações

Esse comando lista os IDs de implantação, as versões e as descrições do projeto de script.

clasp deployments

Abrir o projeto no editor do Apps Script

Esse comando abre um projeto de script no editor do Apps Script. O editor é iniciado como uma nova guia no navegador da Web padrão.

clasp open

Contribua com o projeto de código aberto `clasp`

Contribua com clasp no GitHub.