repository·master·Indexed 26 days ago
https://github.com/google/claspA CLI tool that allows developers to develop Google Apps Script projects locally, enabling the use of local file systems, source control like Git, and modern development tools. It provides commands for project management, including creating, cloning, pushing, and pulling code, as well as advanced features like tailing execution logs and managing deployments. Version 3.3.0 supports integration as a Gemini CLI extension and a Claude Code CLI extension.
To use a specific Google Cloud Platform (GCP) project with your script, you must associate it via the Apps Script editor:
clasp open to open the script in your browser.project-id-xxxxxxxxxxxxxxxxxxx).projectId field of your .clasp.json file.You can use this instructional demo to try clasp operations within a Gitpod environment. To begin, open the demo in Gitpod using the provided button in the repository, then navigate to the demo directory:
cd docs/Gitpod/You can install clasp as a Gemini CLI extension to make it available as an MCP server.
Prerequisites:
clasp login with your specific login parameters before using the extension.gemini extensions install https://github.com/google/claspTo install the clasp CLI globally on your system, use the following command:
npm install -g @google/claspImportant: After installation, you must enable the Google Apps Script API in your Google account settings at: https://script.google.com/home/usersettings
Clasp 3.x no longer transpiles TypeScript code. You must use a bundler (like Rollup) to transform TypeScript into JavaScript before pushing with clasp push.
Several commands have been renamed for consistency. Note that many old commands retain aliases for compatibility.
| 2.x Command | 3.x Command |
|---|---|
open | open-script |
open --web | open-web-app |
open --addon | open-container |
open --creds | open-credentials-setup |
login --creds <file> | login -u <name> --creds <file> |
logs --open | open-logs |
apis --open | open-api-console |
apis enable <api> | enable-api <api> |
apis disable <api> | disable-api <api> |
deploy -i <id> | update-deployment <id> |
To use clasp run [functionName] for remote execution of Apps Script functions, you must complete the following configuration steps:
.clasp.json contains the projectId (the GCP Project ID, not the Script ID).{
"scriptId": "...",
"projectId": "my-sample-project-191923"
}clasp project.clasp open-script.⚙️ Project Settings > Google Cloud Platform (GCP) Project and ensure the correct Project Number is set.clasp open-credentials-setup to follow the guide for creating a Desktop App OAuth client ID.client_secret.json in your project directory.appsscript.json):executionApi configuration:"executionApi": {
"access": "ANYONE"
}clasp login using your custom credentials and the project scopes:
clasp login --user <name> --use-project-scopes --creds client_secret.jsonclasp open-script.Deploy > New deployment.API Executable and click Deploy.Once configured, you can execute Apps Script functions remotely.
clasp push.clasp run. You will be prompted to select a function from a list.clasp run <functionName> (e.g., clasp run helloWorld).The function's result will be displayed in your terminal output.
clasp run helloWorldTo improve security or comply with organizational restrictions, you can use your own OAuth client instead of the default clasp client.
Desktop Application. Download the client secrets file. Use this file with clasp login --creds <filename>.script.googleapis.com) - Requiredserviceusage.googleapis.com) - Requireddrive.googleapis.com) - Requiredlogging.googleapis.com) - RequiredIf registering OAuth scopes for external use, include the following:
https://www.googleapis.com/auth/script.deploymentshttps://www.googleapis.com/auth/script.projectshttps://www.googleapis.com/auth/script.webapp.deployhttps://www.googleapis.com/auth/drive.metadata.readonlyhttps://www.googleapis.com/auth/drive.filehttps://www.googleapis.com/auth/service.managementhttps://www.googleapis.com/auth/logging.readhttps://www.googleapis.com/auth/userinfo.emailhttps://www.googleapis.com/auth/userinfo.profilehttps://www.googleapis.com/auth/cloud-platformTo populate the scriptId field in your .clasp.json file, follow these steps:
scriptId field of your .clasp.json file.If your Apps Script function requires specific scopes (like Gmail or Drive), you must synchronize your clasp login credentials with the scopes declared in your appsscript.json manifest.
appsscript.json file.--use-project-scopes flag to combine manifest scopes with default clasp scopes:
clasp login --user <name> --use-project-scopes --include-clasp-scopes --creds client_secret.json--extra-scopes flag with a comma-separated list:
clasp run --user <name> --extra-scopes scopeA,scopeB <functionName>There are two ways to use clasp with Claude Code CLI:
Run this command directly in Claude Code:
/plugin install @google/claspAdd clasp as an MCP server using one of these methods:
Via npx:
claude mcp add clasp -- npx -y @google/clasp mcpVia JSON configuration file:
claude mcp add-json clasp "$(cat claude-mcp.json)"You can use the global --user option to switch between different authorized accounts. This is useful for running commands as different users or when using clasp run-function.
clasp login # Saves as default credentials
clasp clone # User not specified, runs using default credentials
clasp login --user testaccount # Authorized new named credentials
clasp run-function --user testaccount myFunction # Runs function as test accountclasp login --user testaccount
clasp run-function --user testaccount myFunction