cli-reference

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Goldsky CLI Reference

Goldsky CLI参考文档

Auto-generated from the Goldsky CLI source and turbo binary (turbo 0.9.1). Re-run
node scripts/generate-cli-reference.js
to update.

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

goldsky login / logout

```
goldsky login
```
— Authenticate with Goldsky
```
goldsky logout
```
— Remove stored credentials

```
goldsky login
```
— 登录Goldsky进行身份验证
```
goldsky logout
```
— 删除存储的凭证

goldsky turbo

Manages Turbo streaming pipelines. Delegates to the

turbo

binary.

管理Turbo流处理管道。委托给

turbo

二进制文件执行。

Subcommands

子命令

goldsky turbo apply

goldsky turbo apply

Apply a pipeline definition from YAML file

从YAML文件应用管道定义

goldsky turbo delete

goldsky turbo delete

Delete a pipeline by name

按名称删除管道

goldsky turbo pause

goldsky turbo pause

Pause a pipeline by name

按名称暂停管道

goldsky turbo resume

goldsky turbo resume

Resume a paused pipeline by name

恢复已暂停的管道

goldsky turbo list

goldsky turbo list

List all pipelines in the current project

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

goldsky turbo logs

goldsky turbo logs

Stream logs from a pipeline

流式输出管道日志

goldsky turbo validate

goldsky turbo validate

Validate a pipeline definition without applying it

验证管道定义但不应用

goldsky turbo inspect

goldsky turbo inspect

Inspect live data flowing through a pipeline

检查管道中流动的实时数据

goldsky turbo get

goldsky turbo get

Get pipeline details

获取管道详情

goldsky turbo state

goldsky turbo state

Manage pipeline state

管理管道状态

goldsky pipeline

Commands related to Goldsky pipelines

与Goldsky管道相关的命令

Subcommands

子命令

goldsky pipeline apply <config-path>

goldsky pipeline apply <config-path>

Apply the provided pipeline yaml config. This command creates the pipeline if it doesn

Arguments:

```
<config-path>
```
— path to the yaml pipeline config file. (required)

Options:

```
--from-snapshot <string>
```
— Snapshot that will be used to start the pipeline. Applicable values are:
```
--save-progress
```
— Attempt a snapshot of the pipeline before applying the update. Only applies if the pipeline already has status: ACTIVE and is running without issues. Defaults to saving progress unless pipeline is being updated to status=INACTIVE.
```
--skip-transform-validation
```
— skips the validation of the transforms when updating the pipeline. Defaults to false
```
--skip-validation
```
— skips the validation of the transforms when updating the pipeline. Defaults to false [deprecated]
```
--use-latest-snapshot
```
— attempts to use the latest available snapshot.
```
--status <string>
```
— Status of the pipeline
```
--force
```
— Forces apply without any prompts, useful for using apply in CI

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

参数：

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

选项：

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

goldsky pipeline cancel-update <nameOrConfigPath>

goldsky pipeline cancel-update <nameOrConfigPath>

Cancel in-flight update request

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

取消正在进行的更新请求

参数：

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

goldsky pipeline create <name>

goldsky pipeline create <name>

Create a pipeline

Arguments:

```
<name>
```
— name of the new pipeline (required)

Options:

```
--output, -outputFormat <string>
```
— format of the output. Either json or table. Defaults to table. (default: yaml)
```
--resource-size, -resourceSize <string>
```
— runtime resource size for when the pipeline runs (default: s) (required)
```
--skip-transform-validation
```
— skips the validation of the transforms when creating the pipeline.
```
--description <string>
```
— the description of the new pipeline
```
--definition <string>
```
— definition of the pipeline that includes sources, transforms, sinks. Provided as json eg:
```
--definition-path <string>
```
— path to a json/yaml file with the definition of the pipeline that includes sources, transforms, sinks.
```
--status <string>
```
— the desired status of the pipeline (default: ACTIVE)
```
--use-dedicated-ip
```
— Whether the pipeline should use dedicated egress IPs (required)

创建管道

参数：

```
<name>
```
— 新管道的名称（必填）

选项：

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

goldsky pipeline delete <nameOrConfigPath>

goldsky pipeline delete <nameOrConfigPath>

Delete a pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

Options:

```
--f, -force
```
— Force the deletion without prompting for confirmation

删除管道

参数：

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

选项：

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

goldsky pipeline export [name]

goldsky pipeline export [name]

Export pipeline configurations

Arguments:

```
[name]
```
— pipeline name

Options:

```
--all
```
— Export pipeline configurations for all available pipelines

导出管道配置

参数：

```
[name]
```
— 管道名称

选项：

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

goldsky pipeline get-definition <name>

goldsky pipeline get-definition <name>

Arguments:

```
<name>
```
— pipeline name (required)

Options:

```
--outputFormat, -output <string>
```
— format of the output. Either json or yaml. Defaults to yaml. (default: yaml) [deprecated]

参数：

```
<name>
```
— 管道名称（必填）

选项：

```
--outputFormat, -output <string>
```
— 输出格式，可选json或yaml。默认值为yaml。（默认：yaml）（已弃用）

goldsky pipeline get <nameOrConfigPath>

goldsky pipeline get <nameOrConfigPath>

Get a pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

Options:

```
--outputFormat, -output <string>
```
— format of the output. Either json or table. Defaults to json. (default: yaml) [deprecated]
```
--definition
```
— print the pipeline
```
--version <string>
```
— pipeline version. Returns latest version of the pipeline if not set.

获取管道信息

参数：

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

选项：

```
--outputFormat, -output <string>
```
— 输出格式，可选json或table。默认值为json。（默认：yaml）（已弃用）
```
--definition
```
— 打印管道定义
```
--version <string>
```
— 管道版本。如果未设置，返回管道的最新版本。

goldsky pipeline info <nameOrConfigPath>

goldsky pipeline info <nameOrConfigPath>

Display pipeline information

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

Options:

```
--version <string>
```
— pipeline version. Returns latest version of the pipeline if not set.

显示管道信息

参数：

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

选项：

```
--version <string>
```
— 管道版本。如果未设置，返回管道的最新版本。

goldsky pipeline list

goldsky pipeline list

List all pipelines

Options:

```
--output, -outputFormat <string>
```
— format of the output. Either json or table. Defaults to json. (default: table)
```
--outputVerbosity <string>
```
— Either summary or all. Defaults to summary. (default: summary)
```
--include-runtime-details
```
— includes runtime details for each pipeline like runtime status and errors. Defaults to false.

列出所有管道

选项：

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

goldsky pipeline monitor <nameOrConfigPath>

goldsky pipeline monitor <nameOrConfigPath>

Monitor a pipeline runtime

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

Options:

```
--version <string>
```
— pipeline version, uses latest version if not set.
```
--update-request
```
— monitor update request
```
--max-refreshes, -maxRefreshes <number>
```
— max. number of data refreshes.

监控管道运行时状态

参数：

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

选项：

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

goldsky pipeline pause <nameOrConfigPath>

goldsky pipeline pause <nameOrConfigPath>

Pause a pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

暂停管道

参数：

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

goldsky pipeline resize <nameOrConfigPath> <resourceSize>

goldsky pipeline resize <nameOrConfigPath> <resourceSize>

Resize a pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)
```
<resource-size>
```
— runtime resource size (required)

调整管道资源大小

参数：

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

goldsky pipeline restart <nameOrConfigPath>

goldsky pipeline restart <nameOrConfigPath>

Restart a pipeline. Useful in scenarios where pipeline needs to be restarted without any configuration changes.

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config path (required)

Options:

```
--from-snapshot <string>
```
— Snapshot that will be used to start the pipeline. Applicable values are: (required)
```
--disable-monitoring
```
— Disables monitoring after the command is run. Defaults to false.

重启管道。适用于无需更改配置即可重启管道的场景。

参数：

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

选项：

```
--from-snapshot <string>
```
— 用于启动管道的快照。可选值为：（必填）
```
--disable-monitoring
```
— 命令执行后禁用监控。默认值为false。

goldsky pipeline start <nameOrConfigPath>

goldsky pipeline start <nameOrConfigPath>

Start a pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config path (required)

Options:

```
--use-latest-snapshot
```
— attempts to use the latest available snapshot.
```
--from-snapshot <string>
```
— Snapshot that will be used to start the pipeline. Applicable values are:

启动管道

参数：

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

选项：

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

goldsky pipeline stop <nameOrConfigPath>

goldsky pipeline stop <nameOrConfigPath>

Stop a pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

停止管道

参数：

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

goldsky pipeline update <name>

goldsky pipeline update <name>

Arguments:

```
<name>
```
— name of the pipeline to update. (required)

Options:

```
--outputFormat, -output <string>
```
— format of the output. Either json or table. Defaults to json. (default: yaml) (required) [deprecated]
```
--resource-size, -resourceSize <string>
```
— runtime resource size for when the pipeline runs
```
--status <string>
```
— status of the pipeline
```
--save-progress
```
— takes a snapshot of the pipeline before applying the update. Only applies if the pipeline already has status: ACTIVE. Defaults to saving progress unless pipeline is being updated to status=INACTIVE.
```
--skip-transform-validation
```
— skips the validation of the transforms when updating the pipeline.
```
--use-latest-snapshot
```
— attempts to use the latest available snapshot.
```
--definition <string>
```
— definition of the pipeline that includes sources, transforms, sinks. Provided as json eg:
```
--definition-path <string>
```
— path to a json/yaml file with the definition of the pipeline that includes sources, transforms, sinks.
```
--description <string>
```
— description of the pipeline

参数：

```
<name>
```
— 要更新的管道名称。（必填）

选项：

```
--outputFormat, -output <string>
```
— 输出格式，可选json或table。默认值为json。（默认：yaml）（必填）（已弃用）
```
--resource-size, -resourceSize <string>
```
— 管道运行时的资源大小
```
--status <string>
```
— 管道的状态
```
--save-progress
```
— 在应用更新前对管道创建快照。仅当管道状态为ACTIVE时生效。默认保存进度，除非管道更新后的状态为INACTIVE。
```
--skip-transform-validation
```
— 更新管道时跳过转换验证。
```
--use-latest-snapshot
```
— 尝试使用最新可用的快照。
```
--definition <string>
```
— 包含数据源、转换、输出的管道定义，以JSON格式提供，例如：
```
--definition-path <string>
```
— 包含数据源、转换、输出的管道定义的JSON/YAML文件路径。
```
--description <string>
```
— 管道的描述

goldsky pipeline validate [config-path]

goldsky pipeline validate [config-path]

Validate a pipeline definition or config.

Arguments:

```
[config-path]
```
— path to the yaml pipeline config file.

Options:

```
--definition <string>
```
— definition of the pipeline that includes sources, transforms, sinks. Provided as json eg: [deprecated]
```
--definition-path <string>
```
— path to a json/yaml file with the definition of the pipeline that includes sources, transforms, sinks. [deprecated]

验证管道定义或配置。

参数：

```
[config-path]
```
— YAML管道配置文件的路径。

选项：

```
--definition <string>
```
— 包含数据源、转换、输出的管道定义，以JSON格式提供，例如：（已弃用）
```
--definition-path <string>
```
— 包含数据源、转换、输出的管道定义的JSON/YAML文件路径。（已弃用）

goldsky pipeline snapshots

goldsky pipeline snapshots

Commands related to snapshots

与快照相关的命令

goldsky pipeline snapshots create <nameOrConfigPath>

goldsky pipeline snapshots create <nameOrConfigPath>

Attempts to take a snapshot of the pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

尝试对管道创建快照

参数：

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

goldsky pipeline snapshots list <nameOrConfigPath>

goldsky pipeline snapshots list <nameOrConfigPath>

List snapshots in a pipeline

Arguments:

```
<nameOrConfigPath>
```
— pipeline name or config file path (required)

Options:

```
--version <string>
```
— pipeline version. Returns snapshots across all versions if not set.

列出管道中的快照

参数：

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

选项：

```
--version <string>
```
— 管道版本。如果未设置，返回所有版本的快照。

goldsky subgraph

Commands related to subgraphs

与Subgraph相关的命令

Subcommands

子命令

goldsky subgraph delete <nameAndVersion>

goldsky subgraph delete <nameAndVersion>

Delete a subgraph from Goldsky

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

Options:

```
--f, -force
```
— Force the deletion without prompting for confirmation

从Goldsky中删除Subgraph

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

选项：

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

goldsky subgraph deploy <nameAndVersion>

goldsky subgraph deploy <nameAndVersion>

Deploy a subgraph to Goldsky

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

Options:

```
--path <string>
```
— Path to subgraph
```
--description <string>
```
— Description/notes for the subgraph
```
--from-ipfs-hash <string>
```
— IPFS hash of a publicly deployed subgraph
```
--ipfs-gateway <string>
```
— IPFS gateway to use if downloading the subgraph from IPFS (default: https://ipfs.network.thegraph.com)
```
--from-abi <string>
```
— Generate a subgraph from an ABI
```
--from-url <string>
```
— GraphQL endpoint for a publicly deployed subgraph
```
--remove-graft
```
— Remove grafts from the subgraph prior to deployment
```
--start-block <number>
```
— Change start block of your subgraph prior to deployment. If used in conjunction with --graft-from, this will be the graft block as well.
```
--graft-from <string>
```
— Graft from the latest block of an existing subgraph in the format <name>/<version>
```
--enable-call-handlers
```
— Generate a subgraph from an ABI with call handlers enabled. Only meaningful when used with --from-abi
```
--tag <string>
```
— Tag the subgraph after deployment, comma separated for multiple tags

将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中的嫁接配置
```
--start-block <number>
```
— 部署前更改Subgraph的起始块。如果与--graft-from一起使用，此值将作为嫁接块。
```
--graft-from <string>
```
— 从现有Subgraph的最新块进行嫁接，格式为<name>/<version>
```
--enable-call-handlers
```
— 从ABI生成Subgraph时启用调用处理器。仅当与--from-abi一起使用时有意义
```
--tag <string>
```
— 部署后为Subgraph添加标签，多个标签用逗号分隔

goldsky subgraph init [nameAndVersion]

goldsky subgraph init [nameAndVersion]

Initialize a new subgraph project with basic scaffolding

Arguments:

```
[nameAndVersion]
```
— Name and version of the subgraph, e.g.

Options:

```
--target-path <string>
```
— Target path to write subgraph files to
```
--force
```
— Overwrite existing files at the target path
```
--from-config <string>
```
— Path to instant subgraph JSON configuration file
```
--abi <string>
```
— ABI source(s) for contract(s)
```
--contract <string>
```
— Contract address(es) to watch for events
```
--contract-events <string>
```
— Event names to index for the contract(s)
```
--contract-calls <string>
```
— Call names to index for the contract(s)
```
--network <string>
```
```
--contract-name <string>
```
— Name of the contract(s)
```
--start-block <string>
```
— Block to start at for a contract on a specific network
```
--description <string>
```
— Subgraph description
```
--call-handlers
```
— Enable call handlers for the subgraph
```
--build
```
— Build the subgraph after writing files
```
--deploy
```
— Deploy the subgraph after build

使用基础脚手架初始化新的Subgraph项目

参数：

```
[nameAndVersion]
```
— Subgraph的名称和版本，例如：

选项：

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

goldsky subgraph list [nameAndVersion]

goldsky subgraph list [nameAndVersion]

View deployed subgraphs and tags

Arguments:

```
[nameAndVersion]
```
— Name and version of the subgraph, e.g.

Options:

```
--filter
```
— Limit results to just tags or deployments (choices: tags, deployments)
```
--summary
```
— Summarize subgraphs & versions without all their details

查看已部署的Subgraph和标签

参数：

```
[nameAndVersion]
```
— Subgraph的名称和版本，例如：

选项：

```
--filter
```
— 将结果限制为标签或部署（可选值：tags, deployments）
```
--summary
```
— 汇总Subgraph和版本，不显示所有详情

goldsky subgraph log <nameAndVersion>

goldsky subgraph log <nameAndVersion>

Tail a subgraph

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

Options:

```
--since
```
— Return logs newer than a relative duration like now, 5s, 2m, or 3h (default: 1m)
```
--format
```
— The format used to output logs, use text or json for easier parsed output, use pretty for more readable console output (choices: pretty, json, text) (default: text)
```
--filter
```
— The minimum log level to output (default: info)
```
--levels
```
— The explicit comma separated log levels to include (${SubgraphApi.SubgraphLogLevels.join(
```
--interval <number>
```
— The time in seconds to wait between checking for new logs (default: 5)

追踪Subgraph日志

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

选项：

```
--since
```
— 返回比相对时间更新的日志，例如now、5s、2m或3h（默认：1m）
```
--format
```
— 日志输出格式，使用text或json便于解析，使用pretty便于控制台阅读（可选值：pretty, json, text）（默认：text）
```
--filter
```
— 输出的最低日志级别（默认：info）
```
--levels
```
— 要包含的明确日志级别，用逗号分隔
```
--interval <number>
```
— 检查新日志的时间间隔（秒）（默认：5）

goldsky subgraph pause <nameAndVersion>

goldsky subgraph pause <nameAndVersion>

Pause a subgraph

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

暂停Subgraph

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

goldsky subgraph start <nameAndVersion>

goldsky subgraph start <nameAndVersion>

Start a subgraph

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

启动Subgraph

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

goldsky subgraph update <nameAndVersion>

goldsky subgraph update <nameAndVersion>

Update a subgraph

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

Options:

```
--public-endpoint <string>
```
— Toggle public endpoint for the subgraph (choices: enabled, disabled)
```
--private-endpoint <string>
```
— Toggle private endpoint for the subgraph (choices: enabled, disabled)
```
--description <string>
```
— Description/notes for the subgraph

更新Subgraph

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

选项：

```
--public-endpoint <string>
```
— 切换Subgraph的公共端点（可选值：enabled, disabled）
```
--private-endpoint <string>
```
— 切换Subgraph的私有端点（可选值：enabled, disabled）
```
--description <string>
```
— Subgraph的描述/备注

goldsky subgraph tag

goldsky subgraph tag

Commands related to tags

与标签相关的命令

goldsky subgraph tag create <nameAndVersion>

goldsky subgraph tag create <nameAndVersion>

Create a new tag

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

Options:

```
--tag, -t <string>
```
— The name of the tag (required)

创建新标签

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

选项：

```
--tag, -t <string>
```
— 标签名称（必填）

goldsky subgraph tag delete <nameAndVersion>

goldsky subgraph tag delete <nameAndVersion>

Delete a tag

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

Options:

```
--tag, -t <string>
```
— The name of the tag to delete (required)
```
--f, -force
```
— Force the deletion without prompting for confirmation

删除标签

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

选项：

```
--tag, -t <string>
```
— 要删除的标签名称（必填）
```
--f, -force
```
— 强制删除，不提示确认

goldsky subgraph webhook

goldsky subgraph webhook

Commands related to webhooks

与Webhook相关的命令

goldsky subgraph webhook create <nameAndVersion>

goldsky subgraph webhook create <nameAndVersion>

Create a webhook

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

Options:

```
--name <string>
```
— Name of the webhook, must be unique (required)
```
--url <string>
```
— URL to send events to (required)
```
--entity <string>
```
— Subgraph entity to send events for (required)
```
--secret <string>
```
— The secret you will receive with each webhook request Goldsky sends

创建Webhook

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

选项：

```
--name <string>
```
— Webhook名称，必须唯一（必填）
```
--url <string>
```
— 发送事件的URL（必填）
```
--entity <string>
```
— 要发送事件的Subgraph实体（必填）
```
--secret <string>
```
— Goldsky发送Webhook请求时你将收到的密钥

goldsky subgraph webhook delete [webhook-name]

goldsky subgraph webhook delete [webhook-name]

Delete a webhook

Arguments:

```
<webhook-name>
```
— Name of the webhook to delete (required)

Options:

```
--name <string>
```
— Name of the webhook to delete [deprecated]
```
--f, -force
```
— Force the deletion without prompting for confirmation

删除Webhook

参数：

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

选项：

```
--name <string>
```
— 要删除的Webhook名称（已弃用）
```
--f, -force
```
— 强制删除，不提示确认

goldsky subgraph webhook list-entities <nameAndVersion>

goldsky subgraph webhook list-entities <nameAndVersion>

List possible webhook entities for a subgraph

Arguments:

```
<nameAndVersion>
```
— Name and version of the subgraph, e.g. (required)

列出Subgraph可用的Webhook实体

参数：

```
<nameAndVersion>
```
— Subgraph的名称和版本，例如：（必填）

goldsky subgraph webhook list

goldsky subgraph webhook list

List webhooks

列出所有Webhook

goldsky secret

Commands related to secret management

与密钥管理相关的命令

Subcommands

子命令

goldsky secret create

goldsky secret create

create a secret

Options:

```
--name <string>
```
— the name of the new secret
```
--value <string>
```
— the value of the new secret in json
```
--description <string>
```
— the description of the new secret

创建密钥

选项：

```
--name <string>
```
— 新密钥的名称
```
--value <string>
```
— 新密钥的值（JSON格式）
```
--description <string>
```
— 新密钥的描述

goldsky secret delete <name>

goldsky secret delete <name>

delete a secret

Arguments:

```
<name>
```
— the name of the secret to delete (required)

Options:

```
--f, -force
```
— Force the deletion without prompting for confirmation

删除密钥

参数：

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

选项：

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

goldsky secret list

goldsky secret list

list all secrets

列出所有密钥

goldsky secret reveal <name>

goldsky secret reveal <name>

reveal a secret

Arguments:

```
<name>
```
— the name of the secret (required)

显示密钥内容

参数：

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

goldsky secret update <name>

goldsky secret update <name>

update a secret

Arguments:

```
<name>
```
— the name of the secret (required)

Options:

```
--value <string>
```
— the new value of the secret
```
--description <string>
```
— the new description of the secret

更新密钥

参数：

```
<name>
```
— 要更新的密钥名称（必填）

选项：

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

goldsky project

Commands related to project management

与项目管理相关的命令

Subcommands

子命令

goldsky project create

goldsky project create

Create a project

Options:

```
--name <string>
```
— the name of the new project (required)
```
--team-id <string>
```
— the ID of the team to create the project in (defaults to current project

创建项目

选项：

```
--name <string>
```
— 新项目的名称（必填）
```
--team-id <string>
```
— 创建项目所属团队的ID（默认当前团队）

goldsky project leave

goldsky project leave

Leave a project

Options:

```
--projectId <string>
```
— the ID of the project you want to leave (required)

退出项目

选项：

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

goldsky project list

goldsky project list

List all of the projects you belong to

列出你所属的所有项目

goldsky project update

goldsky project update

Update a project

Options:

```
--name <string>
```
— the new name of the project (required)

更新项目

选项：

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

goldsky project users

goldsky project users

Commands related to the users of a project

与项目用户相关的命令

goldsky project users invite

goldsky project users invite

Invite a user to your project

Options:

```
--emails <array>
```
— emails of users to invite (required)
```
--role <string>
```
— desired role of invited user(s) (default: Viewer) (required)

邀请用户加入项目

选项：

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

goldsky project users list

goldsky project users list

List all users for this project

列出项目的所有用户

goldsky project users remove

goldsky project users remove

Remove a user from your project

Options:

```
--email <string>
```
— email of user to remove (required)

移除项目中的用户

选项：

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

goldsky project users update

goldsky project users update

Update a user

Options:

```
--email <string>
```
— email of user to remove (required)
```
--role <string>
```
— role of user to update (required)

更新用户角色

选项：

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

goldsky dataset

Commands related to Goldsky datasets

与Goldsky数据集相关的命令

Subcommands

子命令

goldsky dataset get <name>

goldsky dataset get <name>

Get a dataset

Arguments:

```
<name>
```
— dataset name (required)

Options:

```
--version <string>
```
— dataset version
```
--outputFormat <string>
```
— the output format. Either json or yaml. Defaults to yaml

获取数据集信息

参数：

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

选项：

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

goldsky dataset list

goldsky dataset list

List datasets

列出所有数据集

goldsky indexed

Analyze blockchain data with indexed.xyz

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

Subcommands

子命令

goldsky indexed rill

goldsky indexed rill

Analyze indexed.xyz data with Rill

使用Rill分析indexed.xyz数据

goldsky indexed sync

goldsky indexed sync

Commands related to syncing indexed.xyz real-time raw & decoded crypto datasets

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

goldsky indexed sync checkpoints

goldsky indexed sync checkpoints

Sync checkpoints (Sui network only)

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: sui)

同步检查点（仅支持Sui网络）

选项：

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

goldsky indexed sync decoded-logs

goldsky indexed sync decoded-logs

Sync decoded logs for a smart contract from a network to this computer

Options:

```
--contract-address <string>
```
— The contract address you are interested in
```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: ethereum)

将网络中智能合约的解码日志同步到本地

选项：

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

goldsky indexed sync events

goldsky indexed sync events

Sync events (Sui network only)

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: sui)

同步事件（仅支持Sui网络）

选项：

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

goldsky indexed sync move-calls

goldsky indexed sync move-calls

Sync Move function calls (Sui network only)

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: sui)

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

选项：

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

goldsky indexed sync packages

goldsky indexed sync packages

Sync packages (Sui network only)

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: sui)

同步包（仅支持Sui网络）

选项：

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

goldsky indexed sync raw-blocks

goldsky indexed sync raw-blocks

Sync all blocks from a network

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: ethereum)

同步网络中的所有区块

选项：

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

goldsky indexed sync raw-logs

goldsky indexed sync raw-logs

Sync all logs from a network

Options:

```
--contract-address <string>
```
— The contract address you are interested in
```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: ethereum)

同步网络中的所有日志

选项：

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

goldsky indexed sync raw-transactions

goldsky indexed sync raw-transactions

Sync all transactions from a network

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: ethereum)

同步网络中的所有交易

选项：

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

goldsky indexed sync sui-transactions

goldsky indexed sync sui-transactions

Sync transactions (Sui network only)

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: sui)

同步交易（仅支持Sui网络）

选项：

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

goldsky indexed sync transaction-objects

goldsky indexed sync transaction-objects

Sync transaction objects (Sui network only)

Options:

```
--network <string>
```
— The network of indexed.xyz data to synchronize (default: sui)

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

选项：

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

goldsky telemetry

Commands related to CLI telemetry

与CLI遥测相关的命令

Subcommands

子命令

goldsky telemetry disable

goldsky telemetry disable

Disable anonymous CLI telemetry

禁用匿名CLI遥测

goldsky telemetry enable

goldsky telemetry enable

Enable anonymous CLI telemetry

启用匿名CLI遥测

goldsky telemetry status

goldsky telemetry status

Display the CLI telemetry status

显示CLI遥测状态