Use la interfaz de línea de comandos con clasp

Para desarrollar y administrar proyectos de Apps Script desde la terminal en lugar del editor de Apps Script, puedes usar una herramienta de código abierto llamada clasp.

En el codelab de clasp, se proporciona una descripción general de todas las funciones de clasp.

Funciones

Desarrolla de forma local

clasp te permite desarrollar tus proyectos de Apps Script de forma local. Puedes escribir código en tu propia computadora y subirlo a Apps Script cuando termines. También puedes descargar proyectos existentes de Apps Script para poder editarlos cuando no tengas conexión. Como el código es local, puedes usar tus herramientas de desarrollo favoritas, como git, cuando compilas proyectos de Apps Script.

Administra versiones de implementación

Crear, actualizar y ver las varias implementaciones de tu proyecto

Código de la estructura

clasp te permite organizar tu código en directorios, que se conservan cuando los subes a script.google.com. Por ejemplo:

# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

# Locally:
├── tests/
│   ├─ slides.gs
│   └─ sheets.gs

Requisitos

clasp está escrito en Node.js y se distribuye a través de la herramienta npm. Antes de usar clasp, debes tener instalada la versión 4.7.4 de Node.js o una posterior. La instalación de Node.js requiere privilegios de administrador.

Instalación

Una vez que hayas instalado Node.js, puedes usar el siguiente comando npm para instalar clasp:

npm install @google/clasp -g

Después de la instalación, puedes usar el comando clasp desde cualquier directorio de tu computadora.

Usa clasp

Puedes usar clasp para controlar varias tareas desde la línea de comandos. En esta sección, se describen las operaciones comunes que puedes usar cuando desarrollas con clasp.

Acceder

Este comando accede y autoriza la administración de los proyectos de Apps Script de tu Cuenta de Google. Una vez que se ejecuta, se te solicita que accedas a una cuenta de Google en la que se almacenan tus proyectos de Apps Script.

clasp login

Cerrar sesión

Este comando cierra la sesión de la herramienta de línea de comandos. Debes volver a acceder con clasp login para volver a autenticarte con Google antes de seguir usando clasp.

clasp logout

Crea un nuevo proyecto de Apps Script

Este comando crea una secuencia de comandos nueva en el directorio actual con un título opcional.

clasp create [scriptTitle]

Este comando también crea dos archivos en el directorio actual:

  • Un archivo .clasp.json que almacena el ID de la secuencia de comandos
  • Un archivo de manifiesto de proyecto appsscript.json que contiene metadatos del proyecto

Clone un proyecto existente

Este comando clona un proyecto existente en el directorio actual. La secuencia de comandos se debe crear o compartir con tu Cuenta de Google. Para especificar el proyecto de secuencia de comandos que quieres clonar, proporciona su ID.

Para encontrar el ID de la secuencia de comandos del proyecto, sigue estos pasos:

  1. Abre el proyecto de Apps Script.
  2. A la izquierda, haz clic en Configuración del proyecto .

  3. En IDs, copia el ID de la secuencia de comandos.

     clasp clone <scriptId>

Cómo descargar un proyecto de secuencia de comandos

Este comando descarga el proyecto de Apps Script de Google Drive al sistema de archivos de tu computadora.

clasp pull

Sube un proyecto de secuencia de comandos

Este comando sube todos los archivos de un proyecto de secuencia de comandos de tu computadora a Google Drive.

clasp push

Genera una lista de versiones del proyecto

Este comando muestra el número y la descripción de cada una de las versiones de un proyecto de secuencia de comandos.

clasp versions

Implementa un proyecto publicado

Puedes implementar proyectos de secuencia de comandos como aplicaciones web, complementos o ejecutables. Puedes crear implementaciones en el editor de secuencia de comandos, en el manifiesto del proyecto o con clasp.

Para implementar un proyecto con clasp, primero crea una versión inmutable del proyecto de Apps Script. Una versión es una "instantánea" de un proyecto de secuencia de comandos y es similar a una versión de rama de solo lectura.

clasp version [description]

Este comando muestra el número de versión creado recientemente. Con ese número, puedes implementar y anular la implementación de instancias de tu proyecto:

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

Este comando actualiza una implementación existente con una versión y una descripción nuevas:

clasp redeploy <deploymentId> <version> <description>

Mostrar lista de implementaciones

Este comando muestra una lista de los IDs de implementación, las versiones y sus descripciones del proyecto de secuencia de comandos.

clasp deployments

Abre el proyecto en el editor de Apps Script

Este comando abre un proyecto de secuencia de comandos en el editor de Apps Script. El editor se inicia como una pestaña nueva en tu navegador web predeterminado.

clasp open

Colabora en el proyecto de código abierto clasp

Contribuye a clasp en GitHub.