Use la interfaz de línea de comandos con clasp

Para desarrollar y administrar proyectos de Apps Script desde tu 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.

Atributos

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 hayas terminado. También puedes descargar proyectos existentes de Apps Script para editarlos cuando estés sin conexión. Como el código es local, puedes usar tus herramientas para desarrolladores favoritas, como git, cuando compiles proyectos de Apps Script.

Administra versiones de implementación

Crea, actualiza y visualiza varias implementaciones de tu proyecto.

Código de 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 se escribe en Node.js y se distribuye a través de la herramienta npm. Antes de usar clasp, debes tener instalada Node.js 4.7.4 o una versión posterior. La instalación de Node.js requiere privilegios administrativos.

Instalación

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

npm install @google/clasp -g

Después de la instalación, el comando clasp estará disponible para su uso desde cualquier directorio de tu computadora.

Usa clasp

Puedes usar clasp para controlar una variedad de 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 ejecute, se te pedirá que accedas a una Cuenta de Google en la que se almacenen tus proyectos de Apps Script.

clasp login

Salir

Con este comando, se sale 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

Cree un nuevo proyecto de Apps Script

Con este comando, se crea una secuencia de comandos nueva en el directorio actual con un título opcional.

clasp create [scriptTitle]

Con este comando, también se crean dos archivos en el directorio actual:

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

Clone un proyecto existente

Este comando clona un proyecto existente en el directorio actual. Debes crear la secuencia de comandos o compartirla con tu Cuenta de Google. Proporciona su ID de secuencia de comandos para especificar el proyecto de la secuencia de comandos que se clonará.

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

Cómo subir 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

Enumerar versiones del proyecto

Con este comando, se muestra la cantidad 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 secuencias 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 ramificada de solo lectura.

clasp version [description]

Este comando muestra el número de versión recién creado. 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

Con este comando, se enumeran los ID de implementación del proyecto de la secuencia de comandos, las versiones y sus descripciones.

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 iniciará como una pestaña nueva en tu navegador web predeterminado.

clasp open

Contribuye al proyecto de código abierto clasp

Contribuye con clasp en GitHub.