Interfaz de línea de comandos con clasp

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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.

El codelab clasp proporciona una descripción general de todas las características 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 hayas terminado. También puedes descargar proyectos de Apps Script existentes para editarlos cuando estés sin conexión. Dado que el código es local, puedes usar tus herramientas de desarrollo favoritas como git cuando compiles proyectos de Apps Script.

Administrar versiones de implementación

Crear, actualizar y ver las distintas implementaciones del 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 de npm. Antes de usar clasp, debes tener instalada la versión 4.7.4 de Node.js o posterior. La instalación de Node.js requiere privilegios administrativos.

Instalación

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

npm install @google/clasp -g

Después de la instalación, el comando clasp está disponible desde cualquier directorio en tu computadora.

Espacio en uso: 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 ejecutado, se te solicitará que accedas a una Cuenta de Google en la que se almacenen tus proyectos de Apps Script.

clasp login

Logout

Este comando sale de la herramienta de línea de comandos. Debes volver a acceder con clasp login para volver a autenticarte con Google antes de continuar usando clasp.

clasp logout

Crear 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 del proyecto appsscript.json que contiene metadatos del proyecto

Clone un proyecto existente

Nuevo editor

Este comando clona un proyecto existente en el directorio actual. La secuencia de comandos debe crearse o compartirse con tu Cuenta de Google. Para especificar el proyecto de secuencia de comandos que se clonará, debes proporcionar su ID de secuencia de comandos.

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

  1. Abre el proyecto Apps Script.
  2. A la izquierda, haz clic en Configuración del proyecto .
  3. Debajo de los ID, copia el ID de la secuencia de comandos.

    clonación de clasp

Editor heredado

Este comando clona un proyecto existente en el directorio actual. La secuencia de comandos debe crearse o compartirse con tu Cuenta de Google. Para especificar el proyecto de secuencia de comandos que se clonará, debes proporcionar su ID de secuencia de comandos. Para encontrar el ID de la secuencia de comandos de un proyecto, abre el proyecto en el editor de Apps Script y selecciona File > Project properties > Info.

clonación de clasp

Descarga un proyecto de secuencia de comandos

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

clasp pull

Subir un proyecto de secuencia de comandos

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

clasp push

Enumerar versiones de proyectos

Este comando enumera 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 secuencias de comandos como aplicaciones web, complementos o ejecutables. Puedes crear implementaciones en el editor de secuencias de comandos, en el manifiesto del proyecto o mediante 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 descripción nuevas:

clasp redeploy <deploymentId> <version> <description>

Mostrar lista de implementaciones

Este comando enumera los ID 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

Contribuye al proyecto de código abierto clasp.

Contribuye a clasp en GitHub.