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 dans 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.

Caractéristiques

Développer localement

clasp vous permet de développer vos projets Apps Script en local. Vous pouvez écrire du code sur votre propre ordinateur et l'importer dans Apps Script lorsque vous avez terminé. Vous pouvez également télécharger des projets Apps Script existants afin de les modifier hors connexion. Le code étant local, vous pouvez utiliser vos outils de développement préférés, tels que git, lorsque vous créez des projets Apps Script.

Gérer les versions de déploiement

Créez, mettez à jour et affichez les 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é Node.js version 4.7.4 ou ultérieure. 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 exécuter 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 lorsque vous développez avec clasp.

Cette commande vous permet de vous connecter et d'autoriser la gestion des projets Apps Script de votre compte Google. Une fois qu'il est 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 se déconnecte de l'outil de ligne de commande. Vous devez vous reconnecter à l'aide de clasp login pour vous authentifier à nouveau 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:

Un fichier .clasp.json stockant l'ID de 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. Vous devez créer le script ou le partager avec votre compte Google. Pour spécifier le projet de script à cloner, fournissez son ID de script.

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

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

Télécharger un projet de script

Cette commande télécharge le projet Apps Script à partir de 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

Répertorier les versions du projet

Cette commande répertorie 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, commencez par créer une version immuable du projet Apps Script. Une version est un "instantané" d'un projet de script. Elle est semblable à une version ramifié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 annuler le déploiement des instances de votre projet:

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

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

clasp redeploy <deploymentId> <version> <description>

Répertorier les déploiements

Cette commande répertorie les ID et les versions de déploiement du projet de script, ainsi que leur description.

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 sous la forme d'un nouvel onglet dans votre navigateur Web par défaut.

clasp open

Contribuez au projet Open Source `clasp`

Apportez votre contribution à clasp sur GitHub.