Usar a interface de linha de comando com o clasp

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

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

Recursos

O clasp inclui os seguintes 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 terminar. Você também pode fazer o download de projetos do Apps Script para editá-los off-line. Use 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 projeto.

Estruturar o código

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

Tipos de projeto

Você pode usar o clasp para gerenciar projetos de script autônomos e vinculados a contêineres.

Projetos autônomos

Um projeto autônomo aparece como um arquivo separado no Google Drive. Você pode criar um novo script autônomo usando o comando clasp create.

Projetos vinculados a contêineres

Um projeto vinculado a contêineres é anexado a um arquivo do Documentos, Planilhas, Apresentações ou Formulários Google. Você pode criar um novo script vinculado a contêineres anexado a um novo arquivo usando o comando clasp create. Você também pode anexar um novo script a um arquivo usando a flag --parentId.

Outros tipos de projeto

O clasp também oferece suporte à criação de scripts para APIs e apps da Web.

Requisitos

clasp é escrito em Node.js e distribuído usando a ferramenta npm. Antes de usar o clasp, é necessário ter o Node.js versão 20.0.0 ou mais recente instalado. A instalação do Node.js exige privilégios administrativos.

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 do seu computador.

Usar clasp

Use o clasp para lidar com várias tarefas na linha de comando. Esta seção descreve operações comuns a serem usadas 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 os projetos do Apps Script estão armazenados.

clasp login

Sair

Esse comando faz logout da ferramenta de linha de comando. Faça login novamente 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 de script opcional.

clasp create [scriptTitle] [--type <projectType>] [--parentId <parentId>]

Esse comando usa os seguintes parâmetros opcionais:

  • scriptTitle: o título do projeto de script.
  • --type <projectType>: o tipo de projeto a ser criado. Os valores permitidos são standalone, docs, sheets, slides, forms, webapp e api.
  • --parentId <parentId>: o ID do arquivo do Google Drive (Documentos, Planilhas, Apresentações ou Formulários) ao qual o novo projeto de script precisa ser vinculado.

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.

Clonar 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 de script a ser clonado fornecendo o ID do script. É possível clonar projetos autônomos e vinculados a contêineres.

Para encontrar o ID do script do projeto:

  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