Utilizzare l'interfaccia a riga di comando con clasp

Per sviluppare e gestire progetti Google Apps Script dal terminale anziché dall'editor Apps Script, utilizza lo strumento open source clasp.

Il clasp codelab fornisce una panoramica di tutte le funzionalità di clasp.

Funzionalità

clasp include le seguenti funzionalità:

Sviluppare localmente

clasp ti consente di sviluppare i tuoi progetti Apps Script localmente. Scrivi il codice sul tuo computer e caricalo su Apps Script al termine. Puoi anche scaricare i progetti Apps Script esistenti per modificarli offline. Utilizza i tuoi strumenti di sviluppo preferiti, come git, quando crei progetti Apps Script.

Gestire le versioni del deployment

Crea, aggiorna e visualizza più deployment del tuo progetto.

Codice struttura

clasp ti consente di organizzare il codice in directory, che vengono conservate quando le carichi su script.google.com. Ad esempio:

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

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

Tipi di progetto

Puoi utilizzare clasp per gestire progetti di script autonomi e associati a container.

Progetti autonomi

Un progetto autonomo viene visualizzato come file separato in Google Drive. Puoi creare un nuovo script autonomo utilizzando il comando clasp create.

Progetti associati a un container

Un progetto associato a un contenitore è collegato a un file Documenti, Fogli, Presentazioni o Moduli Google. Puoi creare un nuovo script associato a un nuovo file utilizzando il comando clasp create. Puoi anche allegare un nuovo script a un file esistente utilizzando il flag --parentId.

Altri tipi di progetti

clasp supporta anche la creazione di script per app web e API.

Requisiti

clasp è scritto in Node.js e distribuito utilizzando lo strumento npm. Prima di utilizzare clasp, devi aver installato Node.js versione 20.0.0 o successive. L'installazione di Node.js richiede privilegi amministrativi.

Installazione

Dopo aver installato Node.js, utilizza il seguente comando npm per installare clasp:

npm install @google/clasp -g

Dopo l'installazione, utilizza il comando clasp da qualsiasi directory del computer.

Utilizza clasp

Utilizza clasp per gestire una serie di attività dalla riga di comando. Questa sezione descrive le operazioni comuni da utilizzare durante lo sviluppo con clasp.

Accedi

Questo comando esegue l'accesso e autorizza la gestione dei progetti Apps Script del tuo Account Google. Una volta eseguito, ti viene chiesto di accedere a un Account Google in cui sono memorizzati i tuoi progetti Apps Script.

clasp login

Esci

Questo comando esegue la disconnessione dallo strumento a riga di comando. Esegui di nuovo l'accesso utilizzando clasp login per eseguire nuovamente l'autenticazione con Google prima di continuare a utilizzare clasp.

clasp logout

Crea un nuovo progetto Apps Script

Questo comando crea un nuovo script nella directory corrente con un titolo opzionale.

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

Questo comando utilizza i seguenti parametri facoltativi:

  • scriptTitle: il titolo del progetto di script.
  • --type <projectType>: il tipo di progetto da creare. I valori consentiti sono standalone, docs, sheets, slides, forms, webapp e api.
  • --parentId <parentId>: l'ID del file Google Drive esistente (Documenti, Fogli, Presentazioni o Moduli) a cui deve essere associato il nuovo progetto di script.

Questo comando crea anche due file nella directory corrente:

  • Un file .clasp.json che memorizza l'ID script.
  • Un file manifest del progetto appsscript.json contenente i metadati del progetto.

Clonare un progetto esistente

Questo comando clona un progetto esistente nella directory corrente. Lo script deve essere creato o condiviso con il tuo Account Google. Specifichi il progetto di script da clonare fornendo il relativo ID script. Puoi clonare sia i progetti autonomi sia quelli associati a un contenitore.

Per trovare l'ID script del progetto:

  1. Apri il progetto Apps Script.
  2. A sinistra, fai clic su Impostazioni progetto .

  3. In ID, copia l'ID script.

    clasp clone

Scaricare un progetto di script

Questo comando scarica il progetto Apps Script da Google Drive al file system del computer.

clasp pull

Caricare un progetto di script

Questo comando carica tutti i file di un progetto di script dal computer su Drive.

clasp push

Elenco delle versioni del progetto

Questo comando elenca il numero e la descrizione di ciascuna versione di un progetto di script.

clasp versions

Eseguire il deployment di un progetto pubblicato

Esegui il deployment dei progetti di script come app web, componenti aggiuntivi di Google Workspace o eseguibili. Crea deployment nell'editor di script, nel manifest del progetto o utilizzando clasp.

Per eseguire il deployment di un progetto con clasp, crea prima una versione immutabile del progetto Apps Script. Una versione è uno "snapshot" di un progetto di script ed è simile a una release ramificata di sola lettura.

clasp version [description]

Questo comando mostra il numero di versione appena creato. Utilizza questo numero per eseguire il deployment e l'annullamento del deployment delle istanze del tuo progetto:

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

Questo comando aggiorna un deployment esistente con una nuova versione e descrizione:

clasp redeploy <deploymentId> <version> <description>

Elenca implementazioni

Questo comando elenca gli ID deployment, le versioni e le relative descrizioni del progetto di script.

clasp deployments

Apri il progetto nell'editor di Apps Script

Questo comando apre un progetto di script nell'editor di Apps Script. L'editor viene avviato come nuova scheda nel browser web predefinito.

clasp open-script

Contribuire al progetto open source clasp

Contribuisci a clasp su GitHub.