Utiliser l'interface de ligne de commande avec clasp

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

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

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 et l'importer dans Apps Script lorsque vous terminé. Vous pouvez également télécharger des projets Apps Script existants afin de pouvoir les modifier lorsque vous êtes hors connexion. Étant donné que le code est local, vous pouvez utiliser votre des outils de développement tels que git lorsque vous créez Apps Script ; projets.

Gérer les versions de déploiement

Créez, mettez à jour et affichez vos multiples 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 Installation de 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 sur votre ordinateur.

clasp utilisé(s)

Vous pouvez utiliser clasp pour gérer diverses tâches à partir de la ligne de commande. Ce décrit les opérations courantes que vous pouvez utiliser lorsque vous développez avec clasp.

Connexion

Cette commande vous permet de vous connecter et d'autoriser la gestion du compte Projets Apps Script. Une fois qu'il est exécuté, vous êtes invité à vous connecter à un 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 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:

  • 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. Le script doit être créé ou partagé avec votre compte Google. Vous spécifiez le script à cloner en indiquant son ID de script.

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

  1. Ouvrez un projet Apps Script.
  2. Sur la gauche, cliquez sur Paramètres du projet .
  3. Sous "ID", copiez l'ID de script.

     clasp clone <scriptId>
    

Télécharger un projet de script

Cette commande permet de télécharger le projet Apps Script de Google Drive vers votre le système de fichiers de l'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, commencez par créer une version immuable des applications Projet de script. Une version est un "instantané" d'un projet de script et est similaire à une version ramifiée en lecture seule.

clasp version [description]

Cette commande affiche le numéro de version nouvellement créé. À l'aide de ce nombre, vous vous pouvez déployer et annuler le déploiement d'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 liste les ID et les versions de déploiement du projet de script, ainsi que leurs des descriptions détaillées.

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

clasp open

Contribuez au projet Open Source clasp

Apportez votre contribution à clasp sur GitHub.