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

Utiliser l'interface de ligne de commande avec le fermoir

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

L'atelier de programmation clasp offre un aperçu de toutes les fonctionnalités de clasp.

Fonctionnalités

Développer localement

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 afin de pouvoir les modifier hors connexion. Comme le code est local, vous pouvez utiliser vos outils de développement préférés tels que git lorsque vous compilez 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 structure

clasp vous permet d'organiser votre code dans des répertoires, qui sont conservés lorsque vous l'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. Pour pouvoir 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 que vous avez installé Node.js, vous pouvez utiliser la commande npm suivante pour installer clasp:

npm install @google/clasp -g

Une fois installée, la commande clasp est disponible et utilisable à 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 se connecte et autorise la gestion des projets Apps Script de votre compte Google. Une fois l'outil exécuté, vous êtes invité à vous connecter à un compte Google où vos projets Apps Script sont stockés.

clasp login

Déconnexion

Cette commande se déconnecte de l'outil de ligne de commande. Avant de continuer à utiliser clasp, vous devez vous reconnecter à l'aide de clasp login pour vous authentifier à nouveau auprès de Google.

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. 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 de 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 de votre ordinateur vers Google Drive.

clasp push

Lister les versions du projet

Cette commande indique le nombre 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 est semblable à une version avec branche en lecture seule.

clasp version [description]

Cette commande affiche le numéro de version que vous venez de créer. Ce numéro vous permet de déployer des instances de votre projet et d'annuler leur déploiement:

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 répertorie les ID et versions de déploiement du projet de script, ainsi que leurs descriptions.

clasp deployments

Ouvrir le projet dans l'éditeur Apps Script

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

clasp open

Contribuer au projet Open Source `clasp`

Contribuez à clasp sur GitHub.