Befehlszeile mit clasp verwenden

Um Apps Script-Projekte von Ihrem Terminal aus zu entwickeln und zu verwalten, Apps Script-Editor können Sie das Open-Source-Tool clasp verwenden.

Das Codelab zu clasp bietet einen Überblick über 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 bestehende Apps Script-Projekte herunterladen, um sie bei Bedarf wenn Sie offline sind. 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 erhalten bleiben. 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 npm-Tool. Zur Verwendung von clasp müssen Sie Node.js Version 4.7.4 oder höher installiert. Für die Installation von Node.js sind Administratorberechtigungen erforderlich.

Installation

Nach der Installation von Node.js können Sie den folgenden npm-Befehl verwenden, um Installieren Sie clasp:

npm install @google/clasp -g

Nach der Installation können Sie den Befehl clasp aus jedem Verzeichnis auf auf Ihrem Computer.

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 des Apps Script-Projekte Nach der Ausführung werden Sie aufgefordert, sich in einem in dem Ihre Apps Script-Projekte gespeichert sind.

clasp login

Abmelden

Mit diesem Befehl werden Sie aus dem Befehlszeilentool abgemeldet. Sie müssen sich erneut mit clasp login, um dich noch einmal bei Google zu authentifizieren, bevor du clasp weiter verwendest.

clasp logout

Neues Apps Script-Projekt erstellen

Dieser Befehl erstellt im aktuellen Verzeichnis ein neues Skript mit einem optionalen Skripttitel.

clasp create [scriptTitle]

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

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

Vorhandenes Projekt klonen

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

So finden Sie die Script-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 aus Google Drive in Ihren im Dateisystem des Computers.

clasp pull

Skriptprojekt hochladen

Mit diesem Befehl werden alle Dateien eines Scriptprojekts von Ihrem Computer auf Google Drive hochgeladen.

clasp push

Projektversionen auflisten

Dieser Befehl listet die Anzahl und Beschreibung der Versionen.

clasp versions

Veröffentlichtes Projekt bereitstellen

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

Erstellen Sie zuerst eine unveränderliche Version der Apps, um ein Projekt mit clasp bereitzustellen Skriptprojekt. Eine Version ist eine „Momentaufnahme“ eines Skriptprojekts und ähnelt einen verzweigten Release mit Lesezugriff.

clasp version [description]

Dieser Befehl zeigt die neu erstellte Versionsnummer an. Mit dieser Nummer kann 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 Deployment-IDs, Versionen und Beschreibungen des Scriptprojekts 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 in einem neuen Tab geöffnet.

clasp open

Zum Open-Source-Projekt clasp beitragen

Erstelle auf GitHub zu clasp.