cli-reference

Goldsky CLI 参考

根据 Goldsky CLI 源代码和 turbo 二进制文件（turbo 0.9.1）自动生成。 重新运行 node scripts/generate-cli-reference.js 以更新。

---

安装

安装基础 Goldsky CLI（提供 goldsky）：

curl https://goldsky.com | sh

goldsky turbo 和 goldsky compose 会委托给单独的二进制文件，这些文件会在首次使用时自动安装（CLI 会提示你）。如需手动安装或更新：

# Turbo — macOS / Linux
curl https://install-turbo.goldsky.com | sh
# Turbo — Windows
irm https://install-turbo.goldsky.com/scripts/install.ps1 | iex

# Compose (installs to ~/.goldsky/bin/compose)
curl -fsSL https://compose.goldsky.com/install | sh
# Update Compose later
goldsky compose update

---

goldsky login / logout

• goldsky login — 使用 Goldsky 进行身份验证
• goldsky logout — 删除已存储的凭据

---

goldsky turbo

管理 Turbo 流式处理管道。此命令会委托给 turbo 二进制文件，该文件会在首次使用时自动安装，也可以通过 curl https://install-turbo.goldsky.com | sh 手动安装（参见“安装”）。

子命令

goldsky turbo apply

从 YAML 文件应用管道定义

goldsky turbo delete

按名称删除管道

goldsky turbo pause

按名称暂停管道

goldsky turbo resume

恢复已暂停的管道

goldsky turbo list

列出当前项目中的所有管道

goldsky turbo logs

流式输出管道日志

goldsky turbo validate

验证管道定义，但不应用

goldsky turbo inspect

检查流经管道的实时数据

goldsky turbo get

获取管道详情

goldsky turbo state

管理管道状态

---

goldsky pipeline

与 Goldsky 管道相关的命令

子命令

goldsky pipeline apply <config-path>

应用提供的管道 YAML 配置。此命令会创建管道（如果它不存在）。

参数：

• <config-path> — YAML 管道配置文件的路径。（必需）

选项：

• --from-snapshot <string> — 用于启动管道的快照。适用值为：
• --save-progress — 尝试在应用更新前对管道进行快照。仅当管道的状态为 ACTIVE 且运行正常时适用。默认会保存进度，除非管道要更新为 status=INACTIVE。
• --skip-transform-validation — 更新管道时跳过转换验证。默认值为 false
• --skip-validation — 更新管道时跳过转换验证。默认值为 false [已弃用]
• --use-latest-snapshot — 尝试使用最新的可用快照。
• --status <string> — 管道状态
• --force — 强制应用，不显示任何提示，适用于在 CI 中使用 apply

goldsky pipeline cancel-update <nameOrConfigPath>

取消正在进行的更新请求

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 （必需）

goldsky pipeline create <name>

创建管道

参数：

• <name> — 新管道的名称 （必需）

选项：

• --output, -outputFormat <string> — 输出格式。可选 json 或 table。默认值为 table。（默认值：yaml）
• --resource-size, -resourceSize <string> — 管道运行时的资源大小 （默认值：s） （必需）
• --skip-transform-validation — 创建管道时跳过转换验证。
• --description <string> — 新管道的描述
• --definition <string> — 包含 sources、transforms、sinks 的管道定义。以 json 格式提供，例如：
• --definition-path <string> — 包含管道定义的 json/yaml 文件路径；该定义包含 sources、transforms、sinks。
• --status <string> — 管道的期望状态 （默认值：ACTIVE）
• --use-dedicated-ip — 是否让管道使用专用出口 IP （必需）

goldsky pipeline delete <nameOrConfigPath>

删除管道

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 （必需）

选项：

• --f, -force — 强制删除，不提示确认

goldsky pipeline export [name]

导出管道配置

参数：

• [name] — 管道名称

选项：

• --all — 导出所有可用管道的配置

goldsky pipeline get-definition <name>

参数：

• <name> — 管道名称 (必填)

选项：

• --outputFormat, -output <string> — 输出格式。可选 json 或 yaml。默认为 yaml。(默认值：yaml) [已弃用]

goldsky pipeline get <nameOrConfigPath>

获取管道

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 (必填)

选项：

• --outputFormat, -output <string> — 输出格式。可选 json 或 table。默认为 json。(默认值：yaml) [已弃用]
• --definition — 打印管道
• --version <string> — 管道版本。未设置时返回管道的最新版本。

goldsky pipeline info <nameOrConfigPath>

显示管道信息

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 (必填)

选项：

• --version <string> — 管道版本。未设置时返回管道的最新版本。

goldsky pipeline list

列出所有管道

选项：

• --output, -outputFormat <string> — 输出格式。可选 json 或 table。默认为 json。(默认值：table)
• --outputVerbosity <string> — 可选 summary 或 all。默认为 summary。(默认值：summary)
• --include-runtime-details — 包含每个管道的运行时详情，例如运行时状态和错误。默认为 false。

goldsky pipeline monitor <nameOrConfigPath>

监控管道运行时

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 (必填)

选项：

• --version <string> — 管道版本，未设置时使用最新版本。
• --update-request — 监控更新请求
• --max-refreshes, -maxRefreshes <number> — 最大数据刷新次数。

goldsky pipeline pause <nameOrConfigPath>

暂停管道

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 (必填)

goldsky pipeline resize <nameOrConfigPath> <resourceSize>

调整管道大小

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 (必填)
• <resource-size> — 运行时资源大小 (必填)

goldsky pipeline restart <nameOrConfigPath>

重启管道。适用于需要在不更改配置的情况下重启管道的场景。

参数：

• <nameOrConfigPath> — 管道名称或配置路径 (必填)

选项：

• --from-snapshot <string> — 用于启动管道的快照。适用值为： (必填)
• --disable-monitoring — 命令运行后禁用监控。默认为 false。

goldsky pipeline start <nameOrConfigPath>

启动管道

参数：

• <nameOrConfigPath> — 管道名称或配置路径 (必填)

选项：

• --use-latest-snapshot — 尝试使用最新的可用快照。
• --from-snapshot <string> — 用于启动管道的快照。适用值为：

goldsky pipeline stop <nameOrConfigPath>

停止管道

参数：

• <nameOrConfigPath> — 管道名称或配置文件路径 (必填)

goldsky pipeline update <name>

参数：

• <name> — 要更新的 pipeline 名称。（必需）

选项：

• --outputFormat, -output <string> — 输出格式。可以是 json 或 table。默认为 json。（默认值：yaml） （必需） [deprecated]
• --resource-size, -resourceSize <string> — pipeline 运行时的资源大小
• --status <string> — pipeline 的状态
• --save-progress — 应用更新前为 pipeline 创建快照。仅当 pipeline 的状态为 ACTIVE 时生效。默认保存进度，除非要将 pipeline 更新为 status=INACTIVE。
• --skip-transform-validation — 更新 pipeline 时跳过 transform 验证。
• --use-latest-snapshot — 尝试使用最新的可用快照。
• --definition <string> — 包含 sources、transforms、sinks 的 pipeline 定义。以 json 格式提供，例如：
• --definition-path <string> — 包含 sources、transforms、sinks 的 pipeline 定义文件（json/yaml）的路径。
• --description <string> — pipeline 的描述

goldsky pipeline validate [config-path]

验证 pipeline 定义或配置。

参数：

• [config-path] — yaml pipeline 配置文件的路径。

选项：

• --definition <string> — 包含 sources、transforms、sinks 的 pipeline 定义。以 json 格式提供，例如： [deprecated]
• --definition-path <string> — 包含 sources、transforms、sinks 的 pipeline 定义文件（json/yaml）的路径。 [deprecated]

goldsky pipeline snapshots

与快照相关的命令

goldsky pipeline snapshots create <nameOrConfigPath>

尝试为 pipeline 创建快照

参数：

• <nameOrConfigPath> — pipeline 名称或配置文件路径 （必需）

goldsky pipeline snapshots list <nameOrConfigPath>

列出 pipeline 中的快照

参数：

• <nameOrConfigPath> — pipeline 名称或配置文件路径 （必需）

选项：

• --version <string> — pipeline 版本。未设置时，返回所有版本的快照。

---

goldsky subgraph

与 subgraph 相关的命令

子命令

goldsky subgraph delete <nameAndVersion>

从 Goldsky 删除 subgraph

参数：

• <nameAndVersion> — subgraph 的名称和版本，例如： （必需）

选项：

• --f, -force — 强制删除，不提示确认

goldsky subgraph deploy <nameAndVersion>

将 subgraph 部署到 Goldsky

参数：

• <nameAndVersion> — subgraph 的名称和版本，例如： （必需）

选项：

• --path <string> — subgraph 的路径
• --description <string> — subgraph 的描述/备注
• --from-ipfs-hash <string> — 已公开部署的 subgraph 的 IPFS 哈希
• --ipfs-gateway <string> — 从 IPFS 下载 subgraph 时使用的 IPFS 网关 （默认值：https://ipfs.network.thegraph.com）
• --from-abi <string> — 根据 ABI 生成 subgraph
• --from-url <string> — 已公开部署的 subgraph 的 GraphQL 端点
• --remove-graft — 部署前从 subgraph 中移除 graft
• --start-block <number> — 部署前更改 subgraph 的起始区块。如果与 --graft-from 一起使用，这也将是 graft 区块。
• --graft-from <string> — 从现有 subgraph 的最新区块进行 graft，格式为 /
• --enable-call-handlers — 生成启用了 call handlers 的 ABI subgraph。仅在与 --from-abi 一起使用时有意义
• --tag <string> — 部署后为 subgraph 添加标签，多个标签以逗号分隔

goldsky subgraph init [nameAndVersion]

使用基本脚手架初始化新的子图项目

参数：

• [nameAndVersion] — 子图名称和版本，例如

选项：

• --target-path <string> — 写入子图文件的目标路径
• --force — 覆盖目标路径中已有的文件
• --from-config <string> — 即时子图 JSON 配置文件的路径
• --abi <string> — 合约的 ABI 来源
• --contract <string> — 要监听事件的合约地址
• --contract-events <string> — 要为合约编制索引的事件名称
• --contract-calls <string> — 要为合约编制索引的调用名称
• --network <string>
• --contract-name <string> — 合约名称
• --start-block <string> — 特定网络上合约开始处理的区块
• --description <string> — 子图描述
• --call-handlers — 为子图启用调用处理程序
• --build — 写入文件后构建子图
• --deploy — 构建后部署子图

goldsky subgraph list [nameAndVersion]

查看已部署的子图和标签

参数：

• [nameAndVersion] — 子图名称和版本，例如

选项：

• --filter — 仅将结果限制为标签或部署 (可选值：tags、deployments)
• --summary — 汇总子图和版本，不显示其全部详细信息

goldsky subgraph log <nameAndVersion>

持续输出子图日志

参数：

• <nameAndVersion> — 子图名称和版本，例如 (必需)

选项：

• --since — 返回晚于相对时长的日志，例如 now、5s、2m 或 3h (默认值：1m)
• --format — 日志输出格式；使用 text 或 json 可获得更易解析的输出，使用 pretty 可获得更易阅读的控制台输出 (可选值：pretty、json、text) (默认值：text)
• --filter — 要输出的最低日志级别 (默认值：info)
• --levels — 要包含的显式逗号分隔日志级别 (${SubgraphApi.SubgraphLogLevels.join(
• --interval <number> — 检查新日志的间隔秒数 (默认值：5)

goldsky subgraph pause <nameAndVersion>

暂停子图

参数：

• <nameAndVersion> — 子图名称和版本，例如 (必需)

goldsky subgraph start <nameAndVersion>

启动子图

参数：

• <nameAndVersion> — 子图名称和版本，例如 (必需)

goldsky subgraph update <nameAndVersion>

更新子图

参数：

• <nameAndVersion> — 子图名称和版本，例如 (必需)

选项：

• --public-endpoint <string> — 切换子图的公共端点 (可选值：enabled、disabled)
• --private-endpoint <string> — 切换子图的私有端点 (可选值：enabled、disabled)
• --description <string> — 子图描述/备注

goldsky subgraph tag

与标签相关的命令

goldsky subgraph tag create <nameAndVersion>

创建新标签

参数：

• <nameAndVersion> — 子图名称和版本，例如 (必需)

选项：

• --tag, -t <string> — 标签名称 (必需)

goldsky subgraph tag delete <nameAndVersion>

删除标签

参数：

• <nameAndVersion> — 子图名称和版本，例如 (必需)

选项：

• --tag, -t <string> — 要删除的标签名称 (必需)
• --f, -force — 强制删除，不提示确认

goldsky subgraph webhook

与 Webhook 相关的命令

goldsky subgraph webhook create <nameAndVersion>

创建 Webhook

参数：

• <nameAndVersion> — 子图名称和版本，例如 (必需)

选项：

• --name <string> — Webhook 名称，必须唯一 (必需)
• --url <string> — 用于接收事件的 URL (必需)
• --entity <string> — 要发送事件的子图实体 (必需)
• --secret <string> — Goldsky 发送的每个 Webhook 请求中都会包含的密钥

goldsky subgraph webhook delete [webhook-name]

删除 Webhook

参数：

• <webhook-name> — 要删除的 Webhook 名称 （必填）

选项：

• --name <string> — 要删除的 Webhook 名称 [deprecated]
• --f, -force — 强制删除，无需确认

goldsky subgraph webhook list-entities <nameAndVersion>

列出子图可能的 Webhook 实体

参数：

• <nameAndVersion> — 子图的名称和版本，例如 （必填）

goldsky subgraph webhook list

列出 Webhook

---

goldsky secret

与密钥管理相关的命令

子命令

goldsky secret create

创建密钥

选项：

• --name <string> — 新密钥的名称
• --value <string> — 新密钥的 JSON 值
• --description <string> — 新密钥的描述

goldsky secret delete <name>

删除密钥

参数：

• <name> — 要删除的密钥名称 （必填）

选项：

• --f, -force — 强制删除，无需确认

goldsky secret list

列出所有密钥

goldsky secret reveal <name>

显示密钥

参数：

• <name> — 密钥名称 （必填）

goldsky secret update <name>

更新密钥

参数：

• <name> — 密钥名称 （必填）

选项：

• --value <string> — 密钥的新值
• --description <string> — 密钥的新描述

---

goldsky project

与项目管理相关的命令

子命令

goldsky project create

创建项目

选项：

• --name <string> — 新项目的名称 （必填）
• --team-id <string> — 要在其中创建项目的团队 ID（默认为当前项目

goldsky project leave

退出项目

选项：

• --projectId <string> — 要退出的项目 ID （必填）

goldsky project list

列出你所属的所有项目

goldsky project update

更新项目

选项：

• --name <string> — 项目的新名称 （必填）

goldsky project users

与项目用户相关的命令

goldsky project users invite

邀请用户加入你的项目

选项：

• --emails <array> — 要邀请的用户邮箱 （必填）
• --role <string> — 受邀用户所需的角色 （默认值：Viewer） （必填）

goldsky project users list

列出此项目的所有用户

goldsky project users remove

从你的项目中移除用户

选项：

• --email <string> — 要移除的用户邮箱 （必填）

goldsky project users update

更新用户

选项：

• --email <string> — 要移除的用户邮箱 （必填）
• --role <string> — 要更新的用户角色 （必填）

---

goldsky dataset

与 Goldsky 数据集相关的命令

子命令

goldsky dataset get <name>

获取数据集

参数：

• <name> — 数据集名称 （必填）

选项：

• --version <string> — 数据集版本
• --outputFormat <string> — 输出格式，可以是 json 或 yaml。默认为 yaml

goldsky dataset list

列出数据集

---

goldsky indexed

使用 indexed.xyz 分析区块链数据

子命令

goldsky indexed rill

使用 Rill 分析 indexed.xyz 数据

goldsky indexed sync

与同步 indexed.xyz 实时原始及解码后的加密数据集相关的命令

goldsky indexed sync checkpoints

同步检查点（仅限 Sui 网络）

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 （默认值：sui）

goldsky indexed sync decoded-logs

将某个网络上的智能合约解码日志同步到此计算机

选项：

• --contract-address <string> — 你关注的合约地址
• --network <string> — 要同步的 indexed.xyz 数据所属网络 （默认值：ethereum）

goldsky indexed sync events

同步事件（仅限 Sui 网络）

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：sui)

goldsky indexed sync move-calls

同步 Move 函数调用（仅限 Sui 网络）

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：sui)

goldsky indexed sync packages

同步包（仅限 Sui 网络）

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：sui)

goldsky indexed sync raw-blocks

同步网络中的所有区块

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：ethereum)

goldsky indexed sync raw-logs

同步网络中的所有日志

选项：

• --contract-address <string> — 你感兴趣的合约地址
• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：ethereum)

goldsky indexed sync raw-transactions

同步网络中的所有交易

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：ethereum)

goldsky indexed sync sui-transactions

同步交易（仅限 Sui 网络）

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：sui)

goldsky indexed sync transaction-objects

同步交易对象（仅限 Sui 网络）

选项：

• --network <string> — 要同步的 indexed.xyz 数据所属网络 (默认：sui)

---

goldsky telemetry

与 CLI 遥测相关的命令

子命令

goldsky telemetry disable

禁用匿名 CLI 遥测

goldsky telemetry enable

启用匿名 CLI 遥测

goldsky telemetry status

显示 CLI 遥测状态

---

goldsky compose

构建并部署链下到链上的 TypeScript 任务。goldsky compose 会委托给独立的 Compose CLI（首次使用时自动安装，也可通过 curl -fsSL https://compose.goldsky.com/install | sh 手动安装 — 请参阅安装）。有关清单字段、所有标志和 TaskContext API，请参阅 compose-reference 技能；如需交互式构建，请使用 compose 技能。

子命令

运行 goldsky compose <cmd> --help 查看标志；完整详情请参阅 compose-reference 技能。

• goldsky compose deploy — 将任务部署到服务端
• goldsky compose start — 使用给定配置启动服务端
• goldsky compose dev — 以开发模式启动服务端
• goldsky compose callTask — 使用 json 负载调用本地运行的任务
• goldsky compose init — 初始化一个包含 Bitcoin 价格预言机的新 Compose 应用
• goldsky compose secret — Compose 密钥
• goldsky compose bundle — 打包任务脚本，但不启动服务端
• goldsky compose codegen — 根据 src/contracts 中的合约 ABI 生成 TypeScript 类
• goldsky compose clean — 打包任务脚本，但不启动服务端
• goldsky compose update — 将 Compose CLI 更新到最新版本