gws-script 是 Google Workspace CLI(gws)中面向 Google Apps Script 的管理模块,版本为 v1。它让用户通过命令行管理 Apps Script 项目,包括项目本身、项目内容、部署、版本以及相关进程信息。
用途 该工具主要用于在终端环境中操作 Google Apps Script 项目。用户可以通过它创建新的脚本项目、获取项目元数据、读取和更新项目内容、查询脚本指标、管理部署与版本,以及运行脚本。它适合需要以脚本化或自动化方式管理 Apps Script 项目的开发者。
前置条件 使用前需要先阅读 ../gws-shared/SKILL.md,以了解认证方式、全局参数和安全规则。如果该文件缺失,可以运行 gws generate-skills 来生成。
命令形式 基本调用形式为:gws script <resource> <method> [flags]。
辅助命令 +push:将本地文件上传到 Apps Script 项目。
API 资源 processes 资源提供以下方法:
- list:列出由用户发起或代表用户发起的进程信息,例如进程类型和当前状态。
- listScriptProcesses:列出某个脚本已执行进程的信息,例如进程类型和当前状态。
projects 资源提供以下方法:
- create:创建一个新的空脚本项目,不包含脚本文件,仅有一个基础清单文件。
- get:获取脚本项目的元数据。
- getContent:获取脚本项目的内容,包括每个脚本文件的代码源和元数据。
- getMetrics:获取脚本的指标数据,例如执行次数和活跃用户数。
- updateContent:更新指定脚本项目的内容。该内容存储为 HEAD 版本,在脚本作为触发器执行、在脚本编辑器中、在插件预览模式下,或作为 Web 应用或开发模式下的 Apps Script API 使用时会被采用。此操作会清除项目中所有现有文件。
- deployments:针对 deployments 资源的操作。
- versions:针对 versions 资源的操作。
scripts 资源提供以下方法:
- run:运行脚本。
发现命令 在调用任何 API 方法之前,建议先检查该方法:
- 浏览资源和方法:gws script --help
- 查看某个方法所需的参数、类型和默认值:gws schema script.<resource>.<method>
使用 gws schema 的输出可以构建 --params 和 --json 参数。
适用场景 适用于需要通过命令行或自动化流程管理 Google Apps Script 项目的场景,例如批量创建项目、读取或更新脚本内容、查询执行指标、管理部署与版本,以及运行脚本。
限制 资料中未提供关于收费、价格、平台支持范围、具体效果或详细使用步骤的更多信息。使用前必须完成 gws-shared 中描述的认证与安全配置。updateContent 会清除项目中所有现有文件,操作时需注意。