Esta página foi traduzida pela API Cloud Translation.

Usar a interface de linha de comando com clasp

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

O codelab clasp fornece uma visão geral de todos os recursos do clasp.

Recursos

Desenvolver localmente

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. Também é possível fazer o download de projetos do Apps Script para editar 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

Crie, atualize e visualize as várias implantações do seu projeto.

Estruturar código

clasp permite que você organize o 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, você precisa ter instalado o Node.js versão 4.7.4 ou posterior. A instalação do Node.js requer privilégios de administrador.

Instalação

Depois de instalar o Node.js, você poderá usar o seguinte comando npm para instalar o clasp:

npm install @google/clasp -g

Após a instalação, o comando clasp poderá ser usado em qualquer diretório do seu computador.

Como usar o `clasp`

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

Este comando faz login e autoriza o gerenciamento dos projetos do Apps Script da sua Conta do Google. Depois de executado, você precisará fazer login na Conta do Google em que seus projetos do Apps Script estão armazenados.

clasp login

Sair

Este comando sai da ferramenta de linha de comando. É necessário fazer login novamente usando clasp login para se autenticar outra vez com o Google antes de continuar usando o clasp.

clasp logout

Criar um novo projeto do Apps Script

Este 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 do projeto appsscript.json contendo os metadados do projeto.

Clone um projeto

Esse comando clona um projeto do diretório atual. O script precisa ser criado ou compartilhado com sua Conta do Google. Para especificar o projeto de script a ser clonado, informe 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

Esse 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 upload de todos os arquivos de um projeto de script do seu 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 resumo 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. Ao usar 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 é aberto 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.