Clasp

clasp is a command-line interface for managing Google Apps Script projects, enabling developers to create, sync, and deploy scripts from a local development environment. It provides an alternative to the cloud-based script editor, allowing version control, offline editing, and integration with standard development workflows.

The tool supports TypeScript transpilation, so developers can write type-annotated code that compiles to JavaScript for the Apps Script runtime. Authentication is handled via OAuth 2.0, and users can synchronize local files with remote projects using ignore patterns similar to .gitignore. clasp also manages versioned deployment snapshots, allowing scripts to be published as web apps, add-ons, or APIs with distinct identifiers.

Beyond basic project management, clasp enables CI/CD automation for linting, testing, and deploying script projects. It supports trigger-based automation across Google services, execution monitoring for running and completed functions, and development of custom spreadsheet functions and chat interfaces. Developers can build and publish add-ons for Google Workspace, manage multiple deployments, and retrieve execution logs. clasp is installed via npm and its documentation is maintained at the GitHub repository.

Features

Apps Script Management - Ships a command-line tool to develop, sync, and deploy Google Apps Script projects from a local environment.

CLI Development Tools - Provides a command-line interface for developing, syncing, and deploying Google Apps Script projects locally.

Deployment Managers - Provides a utility for creating versioned deployments of script projects as web apps, add-ons, or APIs.

Project Managers - Creates, downloads, and uploads script projects to Google Workspace with version control support.

Versioned Deployments - Manages versioned deployment snapshots, allowing scripts to be published as web apps, add-ons, or APIs.

Cloud Script Project Initialization - Creates new script projects in a cloud editor with support for multiple types and custom settings.

Remote File Synchronization - Synchronizes local files with remote script projects by comparing timestamps and transferring changes.

REST API Clients - Sends HTTP requests to the Apps Script API to manage project files, deployments, and executions.

Google Apps Script Pipelines - Automates linting, testing, and deployment of Google Apps Script projects within continuous integration pipelines.

Code File Synchronizers - Synchronize code between a local filesystem and the remote script editor while preserving folder structure and enabling version control and offline development.

Script Project Managers - Creates, reads, and modifies script project files and metadata through a programmatic interface.

Script Deployment Managers - Deploys script versions as web apps or add-ons with create, update, list, and delete operations.

Service Account Authenticators - Authorizes management of script projects by authenticating with a Google Cloud service account.

OAuth 2.0 Authorization Flows - Guides users through a browser-based OAuth 2.0 flow to authorize script management API access.

Immutable Version Snapshots - Creates immutable numbered versions of script projects and publishes them as distinct deployments.

Script Version Snapshots - Creates immutable version snapshots of script projects for change tracking and staged release.

Remote Function Invocation - Enables invoking functions on the remote Apps Script platform via API and retrieving execution results.

CI/CD Automation - Enables automated linting, testing, and deployment of script projects within a CI pipeline.

Automation Triggers - Writes code that runs across Google services when triggered by events, user actions, or schedules.

Workspace Add-on Development - Builds and publishes add-ons that run inside Google Workspace to automate tasks or connect external services.

Google Workspace Add-ins - Creates apps that run inside Google Workspace to automate tasks or connect to external services.

TypeScript Transpilers - Compiles TypeScript source files into plain JavaScript before uploading to the Apps Script runtime.

Apps Script Transpilers - Converts TypeScript files into JavaScript for execution on the Google Apps Script runtime.

Spreadsheet Function Definitions - Enables writing custom spreadsheet functions that behave like built-in formulas and can be called from cells.

Custom Formula Definitions - Writes custom spreadsheet functions that behave like built-in formulas and can be called from cells.

googleclasp

Features

Star history