Befehlszeile mit clasp verwenden

Wenn Sie Apps Script-Projekte nicht im Apps Script-Editor, sondern über das Terminal 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. Sie können auch vorhandene Apps Script-Projekte herunterladen, um sie offline zu bearbeiten. Da der Code lokal ist, können Sie beim Erstellen von Apps Script-Projekten Ihre bevorzugten Entwicklungstools wie git verwenden.

Bereitstellungsversionen verwalten

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

Gebäudecode

Mit clasp können Sie Ihren 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 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 jedem Verzeichnis auf Ihrem Computer aus verwenden.

clasp verwenden

Mit clasp können Sie über die Befehlszeile eine Vielzahl von Aufgaben 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. Danach 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 aus dem Befehlszeilentool abgemeldet. Sie müssen sich mit clasp login wieder anmelden, um sich noch einmal bei Google zu authentifizieren, bevor Sie clasp weiter verwenden können.

clasp logout

Neues Apps Script-Projekt erstellen

Mit diesem Befehl wird im aktuellen Verzeichnis ein neues Script mit einem optionalen Scripttitel erstellt.

clasp create [scriptTitle]

Mit diesem Befehl werden außerdem zwei Dateien im aktuellen Verzeichnis erstellt:

  • Eine .clasp.json-Datei, in der die Script-ID gespeichert ist.
  • Eine appsscript.json-Manifestdatei mit Projektmetadaten.

Vorhandenes Projekt klonen

Mit diesem Befehl wird ein vorhandenes Projekt im aktuellen Verzeichnis geklont. Das Script muss mit Ihrem Google-Konto erstellt oder geteilt werden. Sie geben das zu klonende Script-Projekt an, indem Sie die Script-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 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

Scriptprojekt hochladen

Mit diesem Befehl werden alle Dateien eines Script-Projekts von Ihrem Computer auf Google Drive hochgeladen.

clasp push

Projektversionen auflisten

Dieser Befehl listet die Nummer und Beschreibung der einzelnen Versionen eines Scriptprojekts auf.

clasp versions

Veröffentlichtes Projekt bereitstellen

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

Wenn Sie ein Projekt mit clasp bereitstellen möchten, erstellen Sie zuerst eine unveränderliche Version des Apps Script-Projekts. Eine Version ist eine „Momentaufnahme“ eines Scriptprojekts und ähnelt einem Release mit Lesezugriff auf eine Verzweigung.

clasp version [description]

Mit diesem Befehl wird die neu erstellte Versionsnummer angezeigt. Mit dieser Nummer können Sie Instanzen Ihres Projekts bereitstellen und wieder entfernen:

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 Deployment-IDs, Versionen und Beschreibungen des Scriptprojekts aufgelistet.

clasp deployments

Projekt im Apps Script-Editor öffnen

Mit diesem Befehl wird ein Script-Projekt im Apps Script-Editor geöffnet. Der Editor wird in Ihrem Standardwebbrowser in einem neuen Tab geöffnet.

clasp open

Zum Open-Source-Projekt clasp beitragen

Sie können clasp auf GitHub mitgestalten.