clasp

clasp

用于Google Apps Script项目本地开发和管理的命令行工具

Clasp是一个面向Google Apps Script开发者的命令行工具。它支持本地开发、版本管理、TypeScript编写和命令行脚本运行。Clasp简化项目结构,提供即时部署和自动完成功能,提高开发效率。这款工具适用于个人开发者和团队协作,使Apps Script开发更加便捷。

ClaspApps ScriptGoogle命令行工具本地开发Github开源项目

Clasp

build status <a href="https://coveralls.io/github/google/clasp?branch=master"><img src="https://coveralls.io/repos/github/google/clasp/badge.svg?branch=master" alt="Coverage Status"></a> <a href="https://www.npmjs.com/package/@google/clasp"><img src="https://img.shields.io/npm/v/@google/clasp.svg" alt="npm Version"></a> <a href="https://npmcharts.com/compare/@google/clasp?minimal=true"><img src="https://img.shields.io/npm/dw/@google/clasp.svg" alt="npm Downloads"></a> <a href="https://david-dm.org/google/clasp" title="dependencies status"><img src="https://david-dm.org/google/clasp/status.svg"/></a> <a href="https://github.com/google/gts" title="Code Style: Google"><img src="https://img.shields.io/badge/code%20style-google-blueviolet.svg"/></a>

Develop Apps Script projects locally using clasp (Command Line Apps Script Projects).

<!-- GIF bash prompt: PS1='\[\033[38;5;9m\]❤ \[$(tput sgr0)\]' --> <!-- Width: 888px --> <!-- Commands: clasp create "Hello" ls echo 'function hello() { Logger.log("Hello, Apps Script!"); }' >> hello.js clasp push clasp deploy rm .clasp.json appsscript.json hello.js clear -->

clasp

To get started, try out the codelab!

You can also try clasp in Gitpod, a one-click online IDE for GitHub:

Open in Gitpod

Features

🗺️ Develop Locally: clasp allows you to develop your Apps Script projects locally. That means you can check-in your code into source control, collaborate with other developers, and use your favorite tools to develop Apps Script.

🔢 Manage Deployment Versions: Create, update, and view your multiple deployments of your project.

📁 Structure Code: clasp automatically converts your flat project on script.google.com into folders. For example:

  • On script.google.com:
    • tests/slides.gs
    • tests/sheets.gs
  • locally:
    • tests/
      • slides.js
      • sheets.js

🔷 Write Apps Script in TypeScript: Write your Apps Script projects using TypeScript features:

  • Arrow functions
  • Optional structural typing
  • Classes
  • Type inference
  • Interfaces
  • And more…

➡️ Run Apps Script: Execute your Apps Script from the command line. Features:

  • Instant deployment.
  • Suggested functions Autocomplete (Fuzzy)
  • Easily add custom Google OAuth scopes
  • And more…

- V8 support take advantage of the performance boost of Chrome JavaScript engine:

  • Every ES2019 features (except ES modules)
  • Edit your appsscript.json manifest to choose between the Rhino and V8 engines
  • Typescript users should update their tsconfig.json with the "target": "ES2019" compiler option

Install

First download clasp:

npm install -g @google/clasp

Then enable the Google Apps Script API: https://script.google.com/home/usersettings

Enable Apps Script API

Commands

The following command provide basic Apps Script project management.

Note: Most of them require you to clasp login and clasp create/clone before using the rest of the commands.

clasp

Advanced Commands

NOTE: These commands require you to add your Project ID.

Clasp Run

NOTE: This command requires you to bring your own Google API credentials.

Reference

Login

Logs the user in. Saves the client credentials to a .clasprc.json file.

Options

  • --no-localhost: Do not run a local server, manually enter code instead.
  • --creds <file>: Use custom credentials used for clasp run. Saves a .clasprc.json file to current working directory. This file should be private!
  • --status: Print who you are currently logged in as, if anyone.

Examples

  • clasp login --no-localhost
  • clasp login --creds creds.json
  • clasp login --status

Logout

Logs out the user by deleting client credentials.

Examples

  • clasp logout

Create

Creates a new script project. Prompts the user for the script type if not specified.

Options

  • --type [docs/sheets/slides/forms]: If specified, creates a new add-on attached to a Document, Spreadsheet, Presentation, or Form. If --parentId is specified, this value is ignored.
  • --title <title>: A project title.
  • --rootDir <dir>: Local directory in which clasp will store your project files. If not specified, clasp will default to the current directory.
  • --parentId <id>: A project parent Id.
    • The Drive ID of a parent file that the created script project is bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google Slides file. If not set, a standalone script project is created.
    • i.e. https://docs.google.com/presentation/d/{id}/edit

Examples

  • clasp create
  • clasp create --type standalone (default)
  • clasp create --type docs
  • clasp create --type sheets
  • clasp create --type slides
  • clasp create --type forms
  • clasp create --type webapp
  • clasp create --type api
  • clasp create --title "My Script"
  • clasp create --rootDir ./dist
  • clasp create --parentId "1D_Gxyv*****************************NXO7o"

These options can be combined like so:

  • clasp create --title "My Script" --parentId "1D_Gxyv*****************************NXO7o" --rootDir ./dist

Clone

Clones the script project from script.google.com.

Options

  • scriptId | scriptURL: The script ID or script URL to clone.
  • --versionNumber <number>: The version of the script to clone.
  • --rootDir <dir>: Local directory in which clasp will store your project files. If not specified, clasp will default to the current directory.

Examples

  • clasp clone "15ImUCpyi1Jsd8yF8Z6wey_7cw793CymWTLxOqwMka3P1CzE5hQun6qiC"
  • clasp clone "https://script.google.com/d/15ImUCpyi1Jsd8yF8Z6wey_7cw793CymWTLxOqwMka3P1CzE5hQun6qiC/edit"
  • clasp clone "15ImUCpyi1Jsd8yF8Z6wey_7cw793CymWTLxOqwMka3P1CzE5hQun6qiC" --rootDir ./src

Pull

Fetches a project from either a provided or saved script ID. Updates local files with Apps Script project.

Options

  • --versionNumber <number>: The version number of the project to retrieve.

Examples

  • clasp pull
  • clasp pull --versionNumber 23

Push

Force writes all local files to script.google.com.

Warning: Google scripts APIs do not currently support atomic nor per file operations. Thus the push command always replaces the whole content of the online project with the files being pushed.

Ignores files:

  • That start with a .
  • That don't have an accepted file extension
  • That are ignored (filename matches a glob pattern in the .claspignore file)

Options

  • -f --force: Forcibly overwrites the remote manifest.
  • -w --watch: Watches local file changes. Pushes files every few seconds.

Examples

  • clasp push
  • clasp push -f
  • clasp push --watch

Status

Lists files that will be written to the server on push.

Ignores files:

  • That start with a .
  • That don't have an accepted file extension
  • That are ignored (filename matches a glob pattern in the ignore file)

Options

  • --json: Show status in JSON form.

Examples

  • clasp status
  • clasp status --json

Open

Opens the current directory's clasp project on script.google.com. Provide a scriptId to open a different script. Can also open web apps.

Options

  • [scriptId]: The optional script project to open.
  • --webapp: Open web application in a browser.
  • --creds: Open the URL to create credentials.
  • --addon: List parent IDs and open the URL of the first one.
  • --deploymentId <id>: Use custom deployment ID with --webapp.

Examples

  • clasp open
  • clasp open "15ImUCpyi1Jsd8yF8Z6wey_7cw793CymWTLxOqwMka3P1CzE5hQun6qiC"
  • clasp open --webapp
  • clasp open --creds
  • clasp open --addon
  • clasp open --webapp --deploymentId abcd1234

Deployments

List deployments of a script.

Examples

  • clasp deployments

Deploy

Creates a version and deploys a script. The response gives the deployment ID and the version of the deployment.

For web apps, each deployment has a unique URL. To update/redeploy an existing deployment, provide the deployment ID.

Options

  • -V <version> --versionNumber <version>: The project version to deploy at.
  • -d <description> --description <description>: The deployment description.
  • -i <id> --deploymentId <id>: The deployment ID to redeploy.

Examples

  • clasp deploy (create new deployment and new version)
  • clasp deploy --versionNumber 4 (create new deployment)
  • clasp deploy --description "Updates sidebar logo." (deploy with description)
  • clasp deploy --deploymentId abcd1234 (redeploy and create new version)
  • clasp deploy -V 7 -d "Updates sidebar logo." -i abdc1234

Undeploy

Undeploys a deployment of a script.

Options

  • [deploymentId]: An optional deployment ID.
  • -a --all: Undeploy all deployments.

Examples

  • clasp undeploy (undeploy the last deployment.)
  • clasp undeploy "123"
  • clasp undeploy --all

Version

Creates an immutable version of the script.

Options

  • description: description The description of the script version.

Examples

  • clasp version
  • clasp version "Bump the version."

Versions

List versions of a script.

Examples

  • clasp versions

List

Lists your most recent Apps Script projects.

Examples

  • clasp list: Prints helloworld1 – xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ...

Advanced Commands

NOTE: These commands require Project ID/credentials setup (see below).

Logs

Prints out most recent the StackDriver logs. These are logs from console.log, not Logger.log.

Options

  • --json: Output logs in json format.
  • --open: Open StackDriver logs in a browser.
  • --setup: Setup StackDriver logs.
  • --watch: Retrieves the newest logs every 5 seconds.
  • --simplified: Removes timestamps from the logs.

Examples

clasp logs ERROR Sat Apr 07 2019 10:58:31 GMT-0700 (PDT) myFunction my log error INFO Sat Apr 07 2019 10:58:31 GMT-0700 (PDT) myFunction info message
  • clasp logs --json
  • clasp logs --open
  • clasp logs --watch
  • clasp logs --simplified

Run

Remotely executes an Apps Script function.

The complete step-by-step information on how to use clasp run is available here: Run
Below is a short summary:

  1. Log in with your credentials (clasp login --creds creds.json), see: Run - Prerequisites
  2. Deploy the Script as an API executable (Easiest done via GUI at the moment).
  3. Enable any APIs that are used by the script, see: Run - Function with Scopes
  4. Have the following in your appsscript.json. Be sure it's pushed:
"executionApi": { "access": "ANYONE" }

Options

  • <functionName>: The name of the function in the script that you want to run.
  • --nondev: If true, runs the function in non-devMode.
  • -p <paramString> --params <paramString>: A JSON string array of parameters to pass to the function

Examples

  • clasp run 'sendEmail'
  • clasp run 'addOptions' -p '["string", 123, {"test": "for"}, true]'

List/Enable/Disable Google APIs

List available APIs. Enables and disables Google APIs.

List APIs

Lists Google APIs that can be enabled as Advanced Services.

  • clasp apis
  • clasp apis list

Enable/Disable APIs

Enables or disables APIs with the Google Cloud project. These APIs are used via services like GmailApp and Advanced Services like BigQuery.

The API name can be found using clasp apis list.

  • clasp apis enable drive
  • clasp apis disable drive

Open APIs Console

Open the Google Cloud Console where you can view and manage API access.

  • clasp apis --open

Help

Displays the help function.

Examples

  • clasp
  • clasp help

Setting

Update .clasp.json settings file.

If settingKey is omitted it prints the current settings. If newValue is omitted it returns the current setting value.

Options

  • settingKey: settingKey The key in .clasp.json you want to change
  • newValue: newValue The new value for the setting

Examples

  • clasp setting
  • clasp setting scriptId
  • clasp setting scriptId new-id

Guides

Ignore File (.claspignore)

Like .gitignore, .claspignore allows you to ignore files that you do not wish to not upload on clasp push. Steps:

  1. Create a file called .claspignore in your project's root directory.
  2. Add patterns to be excluded from clasp push. Note: The .claspignore patterns are applied by multimatch, which is different from .gitignore, especially for directories. To ignore a directory, use syntax like **/node_modules/**.

A sample .claspignore ignoring everything except the manifest and

编辑推荐精选

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
DeepEP

DeepEP

DeepSeek开源的专家并行通信优化框架

DeepEP是一个专为大规模分布式计算设计的通信库,重点解决专家并行模式中的通信瓶颈问题。其核心架构采用分层拓扑感知技术,能够自动识别节点间物理连接关系,优化数据传输路径。通过实现动态路由选择与负载均衡机制,系统在千卡级计算集群中维持稳定的低延迟特性,同时兼容主流深度学习框架的通信接口。

DeepSeek

DeepSeek

全球领先开源大模型,高效智能助手

DeepSeek是一家幻方量化创办的专注于通用人工智能的中国科技公司,主攻大模型研发与应用。DeepSeek-R1是开源的推理模型,擅长处理复杂任务且可免费商用。

问小白

问小白

DeepSeek R1 满血模型上线

问小白是一个基于 DeepSeek R1 模型的智能对话平台,专为用户提供高效、贴心的对话体验。实时在线,支持深度思考和联网搜索。免费不限次数,帮用户写作、创作、分析和规划,各种任务随时完成!

AI主流办公工具有哪些办公热门AI 助手
KnowS

KnowS

AI医学搜索引擎 整合4000万+实时更新的全球医学文献

医学领域专用搜索引擎整合4000万+实时更新的全球医学文献,通过自主研发AI模型实现精准知识检索。系统每日更新指南、中英文文献及会议资料,搜索准确率较传统工具提升80%,同时将大模型幻觉率控制在8%以下。支持临床建议生成、文献深度解析、学术报告制作等全流程科研辅助,典型用户反馈显示每周可节省医疗工作者70%时间。

Windsurf Wave 3

Windsurf Wave 3

Windsurf Editor推出第三次重大更新Wave 3

新增模型上下文协议支持与智能编辑功能。本次更新包含五项核心改进:支持接入MCP协议扩展工具生态,Tab键智能跳转提升编码效率,Turbo模式实现自动化终端操作,图片拖拽功能优化多模态交互,以及面向付费用户的个性化图标定制。系统同步集成DeepSeek、Gemini等新模型,并通过信用点数机制实现差异化的资源调配。

AI IDE
腾讯元宝

腾讯元宝

腾讯自研的混元大模型AI助手

腾讯元宝是腾讯基于自研的混元大模型推出的一款多功能AI应用,旨在通过人工智能技术提升用户在写作、绘画、翻译、编程、搜索、阅读总结等多个领域的工作与生活效率。

AI助手AI对话AI工具腾讯元宝智能体热门 AI 办公助手
Grok3

Grok3

埃隆·马斯克旗下的人工智能公司 xAI 推出的第三代大规模语言模型

Grok3 是由埃隆·马斯克旗下的人工智能公司 xAI 推出的第三代大规模语言模型,常被马斯克称为“地球上最聪明的 AI”。它不仅是在前代产品 Grok 1 和 Grok 2 基础上的一次飞跃,还在多个关键技术上实现了创新突破。

OmniParser

OmniParser

帮助AI理解电脑屏幕 纯视觉GUI元素的自动化解析方案

开源工具通过计算机视觉技术实现图形界面元素的智能识别与结构化处理,支持自动化测试脚本生成和辅助功能开发。项目采用模块化设计,提供API接口与多种输出格式,适用于跨平台应用场景。核心算法优化了元素定位精度,在动态界面和复杂布局场景下保持稳定解析能力。

OmniParser界面解析交互区域检测Github开源项目
流畅阅读

流畅阅读

AI网页翻译插件 双语阅读工具,还原母语级体验

流畅阅读是一款浏览器翻译插件,通过上下文智能分析提升翻译准确性,支持中英双语对照显示。集成多翻译引擎接口,允许用户自定义翻译规则和快捷键配置,操作数据全部存储在本地设备保障隐私安全。兼容Chrome、Edge、Firefox等主流浏览器,基于GPL-3.0开源协议开发,提供持续的功能迭代和社区支持。

AI翻译AI翻译引擎AI翻译工具
下拉加载更多