Befehlszeile mit clasp verwenden

Wenn Sie Apps Script-Projekte über Ihr Terminal und nicht über den Apps Script-Editor entwickeln und verwalten möchten, können Sie ein Open-Source-Tool namens clasp verwenden.

Das clasp-Codelab bietet einen Überblick über alle clasp-Funktionen.

Funktionen

Lokal entwickeln

Mit clasp können Sie Ihre Apps Script-Projekte lokal entwickeln. Sie können Code auf Ihrem eigenen Computer schreiben und danach in Apps Script hochladen. Sie können auch vorhandene Apps Script-Projekte herunterladen, um sie offline zu bearbeiten. Da der Code lokal ist, können Sie zum Erstellen von Apps Script-Projekten Ihre bevorzugten Entwicklungstools wie git verwenden.

Bereitstellungsversionen verwalten

mehrere Bereitstellungen des Projekts erstellen, aktualisieren und ansehen.

Gebäudecode

Mit clasp können Sie den Code in Verzeichnissen organisieren, 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

Voraussetzungen

clasp wird in Node.js geschrieben und über das npm-Tool verteilt. Damit Sie clasp verwenden können, müssen Sie Node.js Version 4.7.4 oder höher installiert haben. Für die Installation von Node.js sind Administratorberechtigungen erforderlich.

Installation

Nach der Installation von Node.js können Sie clasp mit dem folgenden npm-Befehl installieren:

npm install @google/clasp -g

Nach der Installation können Sie den Befehl clasp in einem beliebigen Verzeichnis auf Ihrem Computer verwenden.

clasp verwenden

Mit clasp können Sie verschiedene Aufgaben über die Befehlszeile ausführen. In diesem Abschnitt werden häufige Vorgänge beschrieben, die Sie bei der Entwicklung mit clasp verwenden können.

Anmeldung

Mit diesem Befehl melden Sie sich an und autorisiert die Verwaltung der Apps Script-Projekte Ihres Google-Kontos. Nach der Ausführung werden Sie aufgefordert, sich bei einem Google-Konto anzumelden, in dem Ihre Apps Script-Projekte gespeichert sind.

clasp login

Abmelden

Dieser Befehl meldet sich vom Befehlszeilentool ab. Damit Sie clasp weiter verwenden können, müssen Sie sich noch einmal mit clasp login anmelden, um sich wieder bei Google zu authentifizieren.

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]

Mit diesem Befehl werden auch zwei Dateien im aktuellen Verzeichnis erstellt:

  • Eine .clasp.json-Datei, in der die Skript-ID gespeichert wird.
  • Eine appsscript.json-Projektmanifestdatei mit Projektmetadaten.

Vorhandenes Projekt klonen

Dieser Befehl klont ein vorhandenes Projekt im aktuellen Verzeichnis. Das Skript muss erstellt oder für Ihr Google-Konto freigegeben werden. Geben Sie die Skript-ID des zu klonenden Skriptprojekts an.

So finden Sie die Skript-ID des Projekts:

  1. Apps Script-Projekt öffnen.
  2. Klicken Sie links auf Projekteinstellungen .
  3. Kopieren Sie unter „IDs“ die Script-ID.

     clasp clone <scriptId>
    

Skriptprojekt herunterladen

Mit diesem Befehl wird das Apps Script-Projekt von Google Drive in das Dateisystem Ihres Computers heruntergeladen.

clasp pull

Skriptprojekt hochladen

Mit diesem Befehl werden alle Dateien eines Skriptprojekts von Ihrem Computer in Google Drive hochgeladen.

clasp push

Projektversionen auflisten

Dieser Befehl listet die Nummer und Beschreibung jeder Version eines Skriptprojekts auf.

clasp versions

Veröffentlichtes Projekt bereitstellen

Skriptprojekte können als Webanwendungen, Add-ons oder ausführbare Dateien bereitgestellt werden. Bereitstellungen können im Skripteditor, im Projektmanifest oder mit clasp erstellt werden.

Erstellen Sie zuerst eine unveränderliche Version des Apps Script-Projekts, um ein Projekt mit clasp bereitzustellen. Eine Version ist eine „Snapshot“ eines Skriptprojekts und ähnelt einem schreibgeschützten, verzweigten Release.

clasp version [description]

Dieser Befehl zeigt die neu erstellte Versionsnummer an. Mit dieser Nummer können Sie Instanzen Ihres Projekts bereitstellen und deren Bereitstellung aufheben:

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

Dieser Befehl aktualisiert eine vorhandene Bereitstellung mit einer neuen Version und Beschreibung:

clasp redeploy <deploymentId> <version> <description>

Deployments auflisten

Dieser Befehl listet die Bereitstellungs-IDs, Versionen und Beschreibungen des Skriptprojekts auf.

clasp deployments

Projekt im Apps Script-Editor öffnen

Mit diesem Befehl wird im Apps Script-Editor ein Scriptprojekt geöffnet. Der Editor wird als neuer Tab in Ihrem Standardwebbrowser geöffnet.

clasp open

Zum Open-Source-Projekt clasp beitragen

Tragen Sie zu clasp auf GitHub bei.