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

要从终端而不是 Apps 脚本编辑器中,您可以使用一个名为 clasp 的开源工具。

clasp Codelab 概述了 clasp 功能。

功能

在本地开发

借助 clasp,您可以在本地开发 Apps Script 项目。您可以在自己的计算机上编写代码,并在完成后将其上传到 Apps Script。您也可以下载现有的 Apps 脚本项目,以便进行修改 以便在离线状态下使用这些文件由于代码是本地代码,因此您可以在构建 Apps Script 项目时使用自己喜欢的开发工具,例如 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 脚本项目。运行后,系统会要求您登录 Google 存储 Apps 脚本项目的账号。

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 部署项目,请先创建应用的不可变版本 脚本项目。版本是一种“快照”类似于 只读分支版本。

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 贡献代码。