Utiliser l'interface de ligne de commande avec clasp

Pour développer et gérer des projets Google Apps Script depuis votre terminal plutôt que depuis l'éditeur Apps Script, utilisez l'outil Open Source clasp.

L'atelier de programmation clasp présente toutes les fonctionnalités de clasp.

Fonctionnalités

clasp inclut les fonctionnalités suivantes :

Développer en local

clasp vous permet de développer vos projets Apps Script en local. Écrivez du code sur votre propre ordinateur, puis importez-le dans Apps Script lorsque vous avez terminé. Vous pouvez également télécharger des projets Apps Script existants pour les modifier hors connexion. Utilisez vos outils de développement favoris tels que git lorsque vous créez des projets Apps Script.

Gérer les versions de déploiement

Créez, mettez à jour et visualisez différents déploiements de votre projet.

Code de la structure

clasp vous permet d'organiser votre code dans des répertoires, qui sont conservés lorsque vous les importez sur script.google.com. Par exemple :

# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

# Locally:
├── tests/
│   ├─ slides.gs
│   └─ sheets.gs

Types de projets

Vous pouvez utiliser clasp pour gérer les projets de script autonomes et ceux liés à un conteneur.

Projets autonomes

Un projet autonome apparaît sous la forme d'un fichier distinct dans votre Google Drive. Vous pouvez créer un script autonome à l'aide de la commande clasp create.

Projets liés à un conteneur

Un projet lié à un conteneur est associé à un fichier Google Docs, Sheets, Slides ou Google Forms. Vous pouvez créer un script lié à un conteneur associé à un nouveau fichier à l'aide de la commande clasp create. Vous pouvez également associer un nouveau script à un fichier existant à l'aide de l'indicateur --parentId.

Autres types de projets

clasp permet également de créer des scripts pour les applications Web et les API.

Conditions requises

clasp est écrit en Node.js et distribué à l'aide de l'outil npm. Avant d'utiliser clasp, vous devez avoir installé Node.js version 20.0.0 ou ultérieure. L'installation de Node.js nécessite des droits d'administrateur.

Installation

Une fois Node.js installé, utilisez la commande npm suivante pour installer clasp :

npm install @google/clasp -g

Après l'installation, utilisez la commande clasp depuis n'importe quel répertoire de votre ordinateur.

Utiliser clasp

Utilisez clasp pour effectuer diverses tâches à partir de la ligne de commande. Cette section décrit les opérations courantes à utiliser lors du développement avec clasp.

Connexion

Cette commande permet de se connecter et d'autoriser la gestion des projets Apps Script de votre compte Google. Une fois l'outil exécuté, vous êtes invité à vous connecter à un compte Google dans lequel vos projets Apps Script sont stockés.

clasp login

Déconnexion

Cette commande déconnecte l'utilisateur de l'outil de ligne de commande. Reconnectez-vous à l'aide de clasp login pour vous réauthentifier auprès de Google avant de continuer à utiliser clasp.

clasp logout

Créer un projet Apps Script

Cette commande crée un script dans le répertoire actuel avec un titre de script facultatif.

clasp create [scriptTitle] [--type <projectType>] [--parentId <parentId>]

Cette commande utilise les paramètres facultatifs suivants :

  • scriptTitle : titre du projet de script.
  • --type <projectType> : type de projet à créer. Les valeurs autorisées sont standalone, docs, sheets, slides, forms, webapp et api.
  • --parentId <parentId> : ID du fichier Google Drive existant (Docs, Sheets, Slides ou Forms) auquel le nouveau projet de script doit être associé.

Cette commande crée également deux fichiers dans le répertoire actuel :

  • Un fichier .clasp.json stockant l'ID du script.
  • Un fichier manifeste de projet appsscript.json contenant les métadonnées du projet.

Cloner un projet existant

Cette commande clone un projet existant dans le répertoire actuel. Le script doit être créé ou partagé avec votre compte Google. Vous spécifiez le projet de script à cloner en fournissant son ID de script. Vous pouvez cloner des projets autonomes et liés à un conteneur.

Pour trouver l'ID de script du projet :

  1. Ouvrez le projet Apps Script.
  2. Sur la gauche, cliquez sur Paramètres du projet .

  3. Sous ID, copiez l'ID du script.

    clasp clone

Télécharger un projet de script

Cette commande télécharge le projet Apps Script depuis Google Drive vers le système de fichiers de votre ordinateur.

clasp pull

Importer un projet de script

Cette commande importe tous les fichiers d'un projet de script depuis votre ordinateur vers Drive.

clasp push

Lister les versions du projet

Cette commande liste le numéro et la description de chaque version d'un projet de script.

clasp versions

Déployer un projet publié

Déployez des projets de script en tant qu'applications Web, modules complémentaires Google Workspace ou exécutables. Créez des déploiements dans l'éditeur de script, dans le fichier manifeste du projet ou à l'aide de clasp.

Pour déployer un projet avec clasp, commencez par créer une version immuable du projet Apps Script. Une version est un "instantané" d'un projet de script et s'apparente à une version ramifiée en lecture seule.

clasp version [description]

Cette commande affiche le numéro de version nouvellement créé. Utilisez ce numéro pour déployer et annuler le déploiement des instances de votre projet :

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

Cette commande met à jour un déploiement existant avec une nouvelle version et une nouvelle description :

clasp redeploy <deploymentId> <version> <description>

Répertorier les déploiements

Cette commande liste les ID de déploiement, les versions et les descriptions du projet de script.

clasp deployments

Ouvrir le projet dans l'éditeur Apps Script

Cette commande ouvre un projet de script dans l'éditeur Apps Script. L'éditeur s'ouvre dans un nouvel onglet de votre navigateur Web par défaut.

clasp open-script

Contribuer au projet Open Source clasp

Contribuez à clasp sur GitHub.