Befehlszeile mit clasp verwenden

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

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

Funktionen

Lokal entwickeln

Mit clasp können Sie Ihre Apps Script-Projekte lokal entwickeln. Sie können Code auf Ihrem eigenen Computer schreiben und dann 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

Mehrere Bereitstellungen Ihres Projekts erstellen, aktualisieren und ansehen.

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 über das npm-Tool verteilt. Zur Verwendung von clasp müssen Sie Node.js ab Version 4.7.4 installiert haben. 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 aus jedem Verzeichnis auf Ihrem Computer ausführen.

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

Dieser Befehl meldet sich vom Befehlszeilentool ab. Sie müssen sich noch einmal mit clasp login 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 Skript mit einem optionalen Skripttitel erstellt.

clasp create [scriptTitle]

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

  • Eine .clasp.json-Datei mit der Skript-ID.
  • Eine appsscript.json-Projektmanifestdatei mit Projektmetadaten.

Vorhandenes Projekt klonen

Mit diesem Befehl wird ein vorhandenes Projekt im aktuellen Verzeichnis geklont. Das Skript muss erstellt oder für Ihr Google-Konto freigegeben werden. Sie geben das zu klonende Skriptprojekt an, indem Sie seine Skript-ID angeben.

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 die Beschreibung jeder Version eines Skriptprojekts auf.

clasp versions

Veröffentlichtes Projekt bereitstellen

Sie können Skriptprojekte als Web-Apps, Add-ons oder ausführbare Dateien bereitstellen. Sie können Bereitstellungen im Skripteditor, im Projektmanifest oder mit clasp erstellen.

Erstellen Sie zuerst eine unveränderliche Version des Apps Script-Projekts, um ein Projekt mit clasp bereitzustellen. Eine Version ist ein "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>

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 deren Beschreibungen des Skriptprojekts aufgelistet.

clasp deployments

Projekt im Apps Script-Editor öffnen

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

clasp open

Zum Open-Source-Projekt clasp beitragen

Erstelle auf GitHub zu clasp.