GaoDing CLI 使用文档

快速开始

需要 Node.js 20 或更高版本。选择一种包管理器全局安装:

npm install --global --allow-scripts=@gaoding/cli @gaoding/cli
# 或
pnpm add --global --allow-build=@gaoding/cli @gaoding/cli

已安装旧内测包 gaoding-cli 时,请先使用原包管理器卸载旧包;不要同时保留两个包,它们会争用 gd-cli 命令。

安装脚本会同步随包的 gd-cli Skill。接着检查登录状态、完成授权,并从真实组织列表中选择当前组织:

gd-cli auth status
gd-cli auth login
gd-cli org list
gd-cli org current
gd-cli org switch --org <org-id>
交给 Agent 安装

首页“AI Agent”页签中的提示词会引导 Agent 完成安装、登录、组织选择和 Skill 验收;不需要手动拼接命令。

登录、组织与 gd-cli Skill

登录与组织

先检查状态,未登录时再授权。组织 ID 必须来自当前账号的真实列表,不要猜测。

gd-cli auth login [--no-browser]
gd-cli auth status [--json]
gd-cli auth logout
gd-cli org list [--json]
gd-cli org current [--json]
gd-cli org switch [--org <org-id>]

gd-cli Skill

npm、pnpm 全局安装和升级会自动同步 Skill,让兼容的 Agent 知道如何选择创作路线、发现实时模型参数,并安全使用 Editor 与 DAM。

如果使用 --ignore-scripts 安装,或需要补齐 Skill,执行 gd-cli update 。新安装的 Skill 无法被当前会话识别时,请重启 Agent 或新开会话。

Agent 与 Tool 创作

需要澄清、规划、多步骤或多产物交付时使用 Agent;只需一次图片、视频或文本调用时使用 Tool。模型名称、参数、价格和预计耗时均以实时查询结果为准。

01

Agent:完成一项业务任务

先读输入 Schema;需要指定模型时,再读取实时 Model 详情。

gd-cli agent send --schema
gd-cli model list --tool <tool>
gd-cli model get <model>
gd-cli agent send --input request.json
02

Tool:直接调用单项能力

先发现可用 Tool 和 Model,再按所选 Model 的参数构造输入。

gd-cli tool list
gd-cli model list --tool <tool>
gd-cli model get <model>
gd-cli tool call <tool> --schema
gd-cli tool call <tool> --input request.json
  • 提示词放在文本字段,本地媒体使用明确授权的绝对路径。
  • 不要把 Tool、Model、参数或稿豆价格固化在脚本中。
  • 可能已经提交但完成状态未知的付费请求,不自动重试。

AI+ Editor

连接浏览器中当前一个 AI+ Editor 作品,读取当前画布,应用结构化动作,并在截图复查后显式保存。

gd-cli editor connect [target]
gd-cli editor snapshot
gd-cli editor apply --input actions.json
gd-cli editor snapshot
gd-cli editor screenshot --json
gd-cli editor save --json
gd-cli editor disconnect
当前边界

当前支持矩形、圆角矩形、上三角、椭圆、菱形,以及绑定两个图形的直线或折线连接器。 遇到不支持的页面内容时,请换用空白或专用画布,不要覆盖原作品。

每次 Apply 后都重新执行 Snapshot;涉及布局、文字或连接关系时,再获取实际截图复查。 save 会等待作品真实持久化,可能明显慢于其他命令,请保持命令运行直到返回 workId 和作品 URL。

DAM 素材管理

先发现当前组织可用的资源库、文件夹和标签,再查询、下载、上传或整理其中的素材。 资源库、条目和目标位置 ID 都必须来自本轮命令输出。

gd-cli dam repository list --json
gd-cli dam folder list --repository-id <id> --json
gd-cli dam tag list --repository-id <id> --json
gd-cli dam list --repository-id <id>
gd-cli dam search <query> --repository-id <id>
gd-cli dam get <asset> [--json]
gd-cli dam download <asset> --repository-id <id> [--output-dir <directory>]
gd-cli dam upload <file> --repository-id <id> --folder-id <folder-id>
gd-cli dam rename <entry> --kind <asset|folder> --title <title> --repository-id <id>
gd-cli dam move <entry> --kind <asset|folder> --target-folder-id <id> [options]
gd-cli dam copy <entry> --kind <asset|folder> --target-folder-id <id> [options]
gd-cli dam delete <asset> --repository-id <id>
  • 跨资源库查询仅在明确需要时使用 --all-repositories
  • 下载只支持单个素材;重命名、移动和复制一次只处理一个素材或文件夹,不支持批量操作或文件夹下载。
  • 移动或复制到根目录时必须显式传入 --target-folder-id 0 。写入结果未确认时,先查询目标位置,不要重复提交。
  • 删除默认移入回收站;只有明确要求永久删除时才使用 --permanent
  • 回收站列表和恢复尚未开放,不要尝试不存在的回收站命令。
  • 上传受保护路径前,必须取得用户明确授权。

更新、输出与错误处理

gd-cli update 会检查 @gaoding/cli 的 npm latest、更新受支持的全局安装,并同步随包 Skill。CLI 已是最新版时仍会校验 Skill。

GaoDing CLI 最多每小时检查一次 npm 最新版本;发现新版本后,同一本地自然日最多在 stderr 提醒一次。检查失败不影响当前命令, CI=true 时跳过检查。

gd-cli update
0

命令成功。

1

运行、服务或状态失败;只执行错误中明确给出的恢复步骤。

2

命令或参数错误;查看对应命令的 --help 后修正。

130

用户中断;立即停止,不自动重试。

stdout 只承载命令结果,stderr 承载警告、授权提示与错误。稿豆不足时,按错误提供的下一步购买稿豆, 或切换到有可用稿豆的组织,再重新发起创作。

完整命令索引

以下是 v1.0.0 当前公开命令。具体选项以对应命令的 --help 为准。

gd-cli auth login [--no-browser]
gd-cli auth status [--json]
gd-cli auth logout
gd-cli org list [--json]
gd-cli org current [--json]
gd-cli org switch [--org <org-id>]
gd-cli agent send --schema
gd-cli agent send --input <file|->
gd-cli tool list
gd-cli tool call <tool> --schema
gd-cli tool call <tool> --input <file|->
gd-cli model list [--tool <tool>]
gd-cli model get <model>
gd-cli editor connect [target]
gd-cli editor disconnect
gd-cli editor snapshot
gd-cli editor apply --input <file|->
gd-cli editor screenshot [--json]
gd-cli editor save [--json]
gd-cli dam repository list [--json]
gd-cli dam folder list [options]
gd-cli dam tag list [options]
gd-cli dam list [options]
gd-cli dam search <query> [options]
gd-cli dam get <asset> [--json]
gd-cli dam download <asset> [options]
gd-cli dam upload <file> [options]
gd-cli dam rename <entry> --kind <asset|folder> --title <title> [options]
gd-cli dam move <entry> --kind <asset|folder> --target-folder-id <id> [options]
gd-cli dam copy <entry> --kind <asset|folder> --target-folder-id <id> [options]
gd-cli dam delete <asset> [options]
gd-cli update

更新日志

v1.0.0

第一个正式对外版本
  • 支持 Agent 多步骤创作和 Tool 单项能力调用。
  • 支持实时发现 Tool、Model、参数、价格与预计耗时。
  • 全局安装和更新自动同步 gd-cli Skill。
  • 支持账号登录、组织查看与切换。
  • 支持 AI+ Editor 画布读取、结构化编辑、截图复查和保存。
  • 支持 DAM 资源库、文件夹和标签发现,以及素材查询、下载、上传、重命名、移动、复制与删除。
  • 提供稳定的结构化输出、退出码和可执行错误指引。