将命令行界面与 clasp 搭配使用

要从终端(而不是 Apps 脚本编辑器)开发和管理 Apps 脚本项目,您可以使用名为 clasp 的开源工具。

clasp Codelab 简要介绍了所有 clasp 功能。

特性

本地开发

clasp 可让您在本地开发 Apps 脚本项目。您可以在自己的计算机上编写代码,并在完成后将其上传到 Apps 脚本。您还可以下载现有的 Apps 脚本项目,以便在离线状态下进行修改。由于代码是本地代码,因此在构建 Apps 脚本项目时,您可以使用自己喜欢的开发工具(如 git)。

管理部署版本

创建、更新和查看项目的多个部署

结构代码

clasp 可让您将代码整理到目录中,在将代码上传到 script.google.com 时会保留这些目录。例如:

# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

# Locally:
├── tests/
│   ├─ slides.gs
│   └─ sheets.gs

要求

clasp 使用 Node.js 编写并通过 npm 工具分发。在使用 clasp 之前,您必须安装 Node.js 4.7.4 或更高版本。安装 Node.js 需要管理员权限。

安装

安装 Node.js 后,您可以使用以下 npm 命令安装 clasp

npm install @google/clasp -g

安装后,您可以在计算机上的任何目录中使用 clasp 命令。

使用 clasp

您可以在命令行中使用 clasp 处理各种任务。本部分介绍在使用 clasp 进行开发时可以使用的常见操作。

登录

此命令可登录并授权管理您 Google 帐号的 Apps 脚本项目。运行后,系统会要求您登录存储了 Apps 脚本项目的 Google 帐号。

clasp login

退出

此命令将退出命令行工具。您必须先使用 clasp login 重新登录以重新向 Google 进行身份验证,然后才能继续使用 clasp

clasp logout

创建新的 Apps 脚本项目

此命令将在当前目录中创建一个具有可选脚本标题的新脚本。

clasp create [scriptTitle]

此命令还会在当前目录中创建两个文件:

  • 存储脚本 ID 的 .clasp.json 文件。
  • 包含项目元数据的 appsscript.json 项目清单文件。

克隆现有项目

此命令会克隆当前目录中的现有项目。必须创建脚本或将其共享给您的 Google 帐号。您可以通过提供脚本 ID 来指定要克隆的脚本项目。

如需查找项目的脚本 ID,请按以下步骤操作:

  1. 打开 Apps 脚本项目。
  2. 点击左侧的项目设置
  3. 在“ID”下,复制脚本 ID。

     clasp clone <scriptId>
    

下载脚本项目

此命令会将 Apps 脚本项目从 Google 云端硬盘下载到计算机的文件系统。

clasp pull

上传脚本项目

此命令会将脚本项目的所有文件从您的计算机上传到 Google 云端硬盘。

clasp push

列出项目版本

此命令会列出脚本项目的每个版本编号和说明。

clasp versions

部署已发布的项目

您可以将脚本项目部署为 Web 应用、插件或可执行文件。您可以在脚本编辑器、项目清单中或使用 clasp 创建部署

如需使用 clasp 部署项目,请先创建 Apps 脚本项目的不可变版本。版本是脚本项目的“快照”,类似于只读分支版本。

clasp version [description]

此命令会显示新创建的版本号。使用该数字,您可以部署和取消部署项目的实例:

clasp deploy [version] [description]
clasp undeploy <deploymentId>

此命令会使用新版本和说明更新现有部署:

clasp redeploy <deploymentId> <version> <description>

列出部署

此命令会列出脚本项目的部署 ID、版本及其说明。

clasp deployments

在 Apps 脚本编辑器中打开项目

此命令会在 Apps 脚本编辑器中打开一个脚本项目。编辑器会在默认网络浏览器中作为新标签页启动。

clasp open

clasp开源项目做贡献

GitHub 上为 clasp 贡献代码。