Desenvolva e gerencie projetos do Apps Script no seu terminal, e não no
Editor do Apps Script, você pode usar uma ferramenta de código aberto chamada clasp
.
O codelab clasp
oferece uma visão geral de todos
clasp
.
Recursos
Desenvolvimento local
O clasp
permite que você desenvolva seus projetos do Apps Script localmente. Você pode
escrever o código no seu computador e fazer o upload dele para o Apps Script
feito. Você também pode fazer o download de projetos existentes do Apps Script para editá-los
quando você estiver off-line. Como o código é local, é possível usar
ferramentas de desenvolvimento como git
para criar Apps Script
projetos.
Gerenciar versões de implantação
Crie, atualize e visualize seus implantações do seu projeto.
Código da estrutura
clasp
permite organizar o código em diretórios, que são preservados
quando você fizer o upload
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 via
a ferramenta npm
. Antes de usar o clasp
, você precisa ter
Node.js versão 4.7.4 ou mais recente instalado.
A instalação do Node.js exige privilégios de administrador.
Instalação
Depois de instalar o Node.js, use o comando npm
a seguir para
instalar clasp
:
npm install @google/clasp -g
Após a instalação, use o comando clasp
a partir de qualquer diretório do
seu computador.
Como usar o clasp
Você pode usar o clasp
para processar várias tarefas na linha de comando. Isso
descreve operações comuns que podem ser usadas ao desenvolver com clasp
.
Login
Esse comando faz login e autoriza o gerenciamento da conta do Google projetos do Apps Script. Depois da execução, é necessário fazer login em uma onde seus projetos do Apps Script são armazenados.
clasp login
Sair
Esse comando sai da ferramenta de linha de comando. Você deve fazer login novamente usando
clasp login
para fazer a autenticação 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 comando título do script.
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 precisam ser criados ou compartilhados com sua Conta do Google. Você especifica o script projeto a ser clonado fornecendo 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 seu no sistema de arquivos do seu computador.
clasp pull
Fazer upload de um projeto de script
Este 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 mais recentes.
clasp versions
Implantar um projeto publicado
É possível implantar projetos de script como apps da Web, complementos ou executáveis. Você pode
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 dos apps
projeto de script. Uma versão é um "snapshot" de um projeto de script e é semelhante à
uma versão ramificada somente leitura.
clasp version [description]
Esse comando exibe o número da versão recém-criada. Usando esse número, pode 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 os respectivos descrições.
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 em seu navegador da Web padrão.
clasp open
Contribua com o projeto de código aberto clasp
Contribua com clasp
no GitHub.