Usar a interface de linha de comando com a clasp

Para desenvolver e gerenciar projetos do Apps Script no terminal em vez do editor do Apps Script, use uma ferramenta de código aberto chamada clasp.

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

Recursos

Desenvolver localmente

O clasp permite desenvolver projetos do Apps Script localmente. Você pode escrever o código no computador e fazer upload para o Apps Script quando ele estiver pronto. Também é possível fazer o download de projetos do Apps Script para editar off-line. Como o código está no computador, você pode usar suas ferramentas de desenvolvimento favoritas, como git, ao criar projetos do Apps Script.

Gerenciar versões de implantação

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

Código da estrutura

O clasp permite organizar 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

O clasp é gravado em Node.js e distribuído pela ferramenta npm. Antes de usar o clasp, instale o Node.js versão 4.7.4 ou mais recente. 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, você pode usar o comando clasp em qualquer diretório do computador.

Como usar o clasp

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

Login

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

clasp login

Sair

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

clasp logout

Criar um novo projeto do Apps Script

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

clasp create [scriptTitle]

Esse 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 que contém metadados do projeto.

Clone um projeto

Esse comando clona um projeto 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:

  1. Abra o projeto do Apps Script.
  2. À esquerda, clique em Configurações do projeto .

  3. Em "IDs", copie o ID do script.

     clasp clone <scriptId>

Baixar 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 "instantâneo" de um projeto de script e é semelhante a um lançamento ramificado somente leitura.

clasp version [description]

Esse comando mostra o número da versão recém-criada. Com esse número, você pode implantar e remover a implantação de instâncias do seu projeto:

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

Este comando atualiza uma implantação existente 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

Abra 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

Contribuir com o projeto de código aberto clasp

Contribua com clasp no GitHub.