Befehlszeile mit clasp verwenden

Wenn Sie 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

Lokal entwickeln

Mit clasp können Sie Ihre Apps Script-Projekte lokal entwickeln. Sie können 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. Da der Code lokal ist, können Sie Ihre bevorzugten Entwicklungstools wie git verwenden, wenn Sie Apps Script-Projekte erstellen.

Deployment-Versionen verwalten

Sie können mehrere Bereitstellungen Ihres Projekts erstellen, aktualisieren und aufrufen.

Gebäudecode

Mit clasp können Sie Ihren Code in Verzeichnisse unterteilen, 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 ist in Node.js geschrieben und wird über das Tool npm verteilt. Bevor Sie clasp verwenden können, muss Node.js Version 4.7.4 oder höher installiert sein. Für die Installation von Node.js sind Administratorberechtigungen erforderlich.

Installation

Nachdem Sie Node.js installiert haben, können Sie clasp mit dem folgenden npm-Befehl 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 Sie bei der Entwicklung mit clasp verwenden können.

Anmelden

Mit diesem Befehl melden Sie sich an und autorisieren die Verwaltung der Apps Script-Projekte Ihres Google-Kontos. 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. Sie müssen sich mit clasp login neu anmelden, um sich bei Google neu zu authentifizieren, bevor Sie clasp weiterhin verwenden können.

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 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.

So finden Sie die Script-ID des Projekts:

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

     clasp clone <scriptId>
    

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 in Google 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

Sie können Skriptprojekte als Webanwendungen, Add-ons oder ausführbare Dateien bereitstellen. Sie können Bereitstellungen im Skripteditor, im Manifest des Projekts oder mit clasp erstellen.

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 Release mit schreibgeschützten Branches.

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 gestartet.

clasp open

Beiträge zum Open-Source-Projekt clasp leisten

Beiträge zu clasp auf GitHub leisten