Interface de linha de comando usando fecho

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 oferece uma visão geral de todos os recursos do clasp.

Recursos

Desenvolver localmente

O clasp permite desenvolver projetos do Apps Script localmente. Escreva o código no seu computador e faça upload para o Apps Script quando ele estiver pronto. Também é possível fazer o download de projetos do Apps Script para editá-los off-line. Como o código é local, 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 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 com a ferramenta npm. Antes de usar o clasp, você precisa ter o Node.js versão 4.7.4 ou posterior instalado. A instalação do Node.js requer privilégios administrativos.

Instalação

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

npm install @google/clasp -g

Após a instalação, o comando clasp estará disponível para uso em qualquer diretório no seu computador.

Como usar o clasp

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

Fazer login

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

clasp login

Sair

Esse comando sai da ferramenta de linha de comando. É necessário fazer login novamente usando clasp login para se autenticar novamente no Google antes de continuar a usar 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]

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

Clone um projeto

Esse comando clona um projeto existente no diretório atual. O script precisa ser criado ou compartilhado com sua Conta do Google. Especifique o projeto do script a ser clonado fornecendo 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>
    

Fazer o download de um projeto de script

Esse comando faz o download do projeto do Apps Script no 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 o 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-criado. Com esse número, é possível implantar e remover 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, as versões e as descrições dos projetos de script do projeto.

clasp deployments

Abrir o projeto no editor do Apps Script

Este 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 de clasp

Contribua com clasp no GitHub.