Wenn Sie Google Apps Script-Projekte lieber über das Terminal als über den Apps Script-Editor entwickeln und verwalten möchten, können Sie das Open-Source-Tool clasp verwenden.
Das clasp-Codelab bietet einen Überblick über alle clasp-Funktionen.
Funktionen
clasp umfasst die folgenden Funktionen:
Lokal entwickeln
Mit clasp können Sie Ihre Apps Script-Projekte lokal entwickeln. Code auf Ihrem eigenen Computer schreiben und anschließend in Apps Script hochladen. Auch vorhandene Apps Script-Projekte lassen sich herunterladen und dann offline bearbeiten. Verwenden Sie Ihre bevorzugten Entwicklungstools wie git, wenn Sie Apps Script-Projekte erstellen.
Bereitstellungsversionen verwalten
Sie können mehrere Bereitstellungen Ihres Projekts erstellen, aktualisieren und aufrufen.
Gebäudecode
Mit clasp können Sie Ihren Code in Verzeichnisse einteilen, die beim Hochladen auf script.google.com beibehalten werden. Beispiel:
# On script.google.com: ├── tests/slides.gs └── tests/sheets.gs # Locally: ├── tests/ │ ├─ slides.gs │ └─ sheets.gs
Projekttypen
Mit clasp können Sie sowohl eigenständige als auch containergebundene Skriptprojekte verwalten.
Eigenständige Projekte
Ein eigenständiges Projekt wird als separate Datei in Google Drive angezeigt. Mit dem Befehl clasp create können Sie ein neues eigenständiges Skript erstellen.
Containergebundene Projekte
Ein containergebundenes Projekt ist an eine Datei in Google Docs, Google Sheets, Google Präsentationen oder Google Formulare angehängt. Mit dem Befehl clasp create können Sie ein neues containergebundenes Skript erstellen, das an eine neue Datei angehängt wird. Sie können auch ein neues Skript an eine vorhandene Datei anhängen, indem Sie das Flag --parentId verwenden.
Andere Projekttypen
Mit clasp lassen sich auch Skripts für Webanwendungen und APIs erstellen.
Voraussetzungen
clasp ist in Node.js geschrieben und wird über das npm-Tool verteilt. Bevor Sie clasp verwenden können, muss Node.js Version 20.0.0 oder höher installiert sein.
Für die Installation von Node.js sind Administratorberechtigungen erforderlich.
Installation
Nachdem Sie Node.js installiert haben, verwenden Sie den folgenden npm-Befehl, um clasp zu installieren:
npm install @google/clasp -g
Nach der Installation können Sie den Befehl clasp von einem beliebigen Verzeichnis auf Ihrem Computer aus verwenden.
„clasp“ verwenden
Mit clasp können Sie eine Vielzahl von Aufgaben über die Befehlszeile ausführen. In diesem Abschnitt werden häufige Vorgänge beschrieben, die bei der Entwicklung mit clasp verwendet werden.
Anmelden
Mit diesem Befehl wird die Verwaltung der Apps Script-Projekte Ihres Google-Kontos autorisiert. Nach der Ausführung werden Sie aufgefordert, sich in einem Google-Konto anzumelden, in dem Ihre Apps Script-Projekte gespeichert sind.
clasp login
Abmelden
Mit diesem Befehl werden Sie vom Befehlszeilentool abgemeldet. Melden Sie sich mit clasp login noch einmal an, um sich bei Google neu zu authentifizieren, bevor Sie clasp weiter verwenden.
clasp logout
Neues Apps Script-Projekt erstellen
Mit diesem Befehl wird im aktuellen Verzeichnis ein neues Skript mit einem optionalen Skripttitel erstellt.
clasp create [scriptTitle] [--type <projectType>] [--parentId <parentId>]
Dieser Befehl verwendet die folgenden optionalen Parameter:
scriptTitle: Der Titel des Scriptprojekts.--type <projectType>: Der Typ des zu erstellenden Projekts. Zulässige Werte sindstandalone,docs,sheets,slides,forms,webappundapi.--parentId <parentId>: Die ID der vorhandenen Google Drive-Datei (Docs, Sheets, Präsentationen oder Formulare), an die das neue Skriptprojekt gebunden werden soll.
Mit diesem Befehl werden auch zwei Dateien im aktuellen Verzeichnis erstellt:
- Eine
.clasp.json-Datei, in der die Skript-ID gespeichert ist. - Eine
appsscript.json-Projektmanifestdatei mit Projektmetadaten.
Vorhandenes Projekt klonen
Mit diesem Befehl wird ein vorhandenes Projekt in das aktuelle Verzeichnis geklont. Das Skript muss mit Ihrem Google-Konto erstellt oder für Ihr Google-Konto freigegeben werden. Sie geben das zu klonende Skriptprojekt an, indem Sie die Skript-ID angeben. Sie können sowohl eigenständige als auch containergebundene Projekte klonen.
So finden Sie die Script-ID des Projekts:
- Öffnen Sie das Apps Script-Projekt.
- Klicken Sie links auf Projekteinstellungen .
Kopieren Sie unter IDs die Script-ID.
clasp clone
Skriptprojekt herunterladen
Mit diesem Befehl wird das Apps Script-Projekt aus Google Drive in das Dateisystem Ihres Computers heruntergeladen.
clasp pull
Skriptprojekt hochladen
Mit diesem Befehl werden alle Dateien eines Skriptprojekts von Ihrem Computer auf Drive hochgeladen.
clasp push
Projektversionen auflisten
Mit diesem Befehl werden die Nummer und die Beschreibung der einzelnen Versionen eines Skriptprojekts aufgeführt.
clasp versions
Veröffentlichtes Projekt bereitstellen
Stellen Sie Scriptprojekte als Webanwendungen, Google Workspace-Add-ons oder ausführbare Dateien bereit. Erstellen Sie Bereitstellungen im Scripteditor, im Projektmanifest oder mit clasp.
Wenn Sie ein Projekt mit clasp bereitstellen möchten, müssen Sie zuerst eine unveränderliche Version des Apps Script-Projekts erstellen. Eine Version ist eine „Momentaufnahme“ eines Skriptprojekts und ähnelt einem schreibgeschützten Release mit Verzweigung.
clasp version [description]
Mit diesem Befehl wird die neu erstellte Versionsnummer angezeigt. Mit dieser Nummer können Sie Instanzen Ihres Projekts bereitstellen und die Bereitstellung aufheben:
clasp deploy [version] [description]
clasp undeploy <deploymentId>
Mit diesem Befehl wird eine vorhandene Bereitstellung mit einer neuen Version und Beschreibung aktualisiert:
clasp redeploy <deploymentId> <version> <description>
Deployments auflisten
Mit diesem Befehl werden die Bereitstellungs-IDs, Versionen und Beschreibungen des Skriptprojekts aufgeführt.
clasp deployments
Projekt im Apps Script-Editor öffnen
Mit diesem Befehl wird ein Skriptprojekt im Apps Script-Editor geöffnet. Der Editor wird als neuer Tab in Ihrem Standardbrowser geöffnet.
clasp open-script
Beiträge zum Open-Source-Projekt clasp leisten
Beiträge zu clasp auf GitHub leisten