Cette page a été traduite par l'API Cloud Translation.

Utiliser l'interface de ligne de commande avec clasp

Pour développer et gérer des projets Apps Script à partir de votre terminal plutôt que de l'éditeur Apps Script, vous pouvez utiliser un outil Open Source appelé clasp.

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

Fonctionnalités

Développer en local

clasp vous permet de développer vos projets Apps Script en local. Vous pouvez écrire du code sur votre propre ordinateur, puis l'importer dans Apps Script lorsque vous avez terminé. Vous pouvez également télécharger des projets Apps Script existants pour pouvoir les modifier lorsque vous êtes hors connexion. Étant donné que le code est local, vous pouvez utiliser 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 vos 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

Conditions requises

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

Installation

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

npm install @google/clasp -g

Après l'installation, vous pouvez utiliser la commande clasp à partir de n'importe quel répertoire de votre ordinateur.

Utiliser `clasp`

Vous pouvez utiliser clasp pour gérer diverses tâches à partir de la ligne de commande. Cette section décrit les opérations courantes que vous pouvez utiliser lors du développement avec clasp.

Cette commande vous connecte et autorise la gestion des projets Apps Script de votre compte Google. Une fois l'exécution terminée, vous êtes invité à vous connecter à un compte Google dans lequel vos projets Apps Script sont stockés.

clasp login

Déconnexion

Cette commande vous déconnecte de l'outil de ligne de commande. Vous devez vous reconnecter à 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]

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

Fichier .clasp.json stockant l'ID du script.
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.

Pour trouver l'ID de script du projet, procédez comme suit:

Ouvrez le projet Apps Script.
Sur la gauche, cliquez sur Paramètres du projet .
Sous "ID", copiez l'ID du script.
```
 clasp clone <scriptId>
```

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

clasp push

Lister les versions du projet

Cette commande liste le numéro et la description de chacune des versions d'un projet de script.

clasp versions

Déployer un projet publié

Vous pouvez déployer des projets de script en tant qu'applications Web, modules complémentaires ou exécutables. Vous pouvez créer 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, créez d'abord une version immuable du projet Apps Script. Une version est un "instantané" d'un projet de script et ressemble à une version branchée en lecture seule.

clasp version [description]

Cette commande affiche le numéro de version nouvellement créé. À l'aide de ce numéro, vous pouvez déployer et désinstaller 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 leurs 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

Contribuer au projet Open Source `clasp`

Contribuez à clasp sur GitHub.