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 — パイプラインの更新時に、transform の検証をスキップします。デフォルトは false です
• --skip-validation — パイプラインの更新時に、transform の検証をスキップします。デフォルトは 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 — パイプライン作成時に、transform の検証をスキップします。
• --description <string> — 新しいパイプラインの説明です
• --definition <string> — sources、transforms、sinks を含むパイプラインの定義です。JSON で指定します。例：
• --definition-path <string> — sources、transforms、sinks を含むパイプラインの定義を記載した JSON／YAML ファイルへのパスです。
• --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> — 更新するパイプラインの名前です。(必須)

オプション：

• --outputFormat, -output <string> — 出力形式です。json または table を指定します。デフォルトは json です。(デフォルト：yaml) (必須) [非推奨]
• --resource-size, -resourceSize <string> — パイプラインの実行時に使用するリソースサイズです。
• --status <string> — パイプラインのステータスです。
• --save-progress — 更新を適用する前にパイプラインのスナップショットを作成します。パイプラインのステータスがすでに ACTIVE の場合にのみ適用されます。パイプラインを status=INACTIVE に更新する場合を除き、デフォルトで進行状況を保存します。
• --skip-transform-validation — パイプラインの更新時にトランスフォームの検証をスキップします。
• --use-latest-snapshot — 利用可能な最新のスナップショットを使用しようとします。
• --definition <string> — ソース、トランスフォーム、シンクを含むパイプラインの定義です。json で指定します。例：
• --definition-path <string> — ソース、トランスフォーム、シンクを含むパイプライン定義を記述した json/yaml ファイルへのパスです。
• --description <string> — パイプラインの説明です。

goldsky pipeline validate [config-path]

パイプラインの定義または設定を検証します。

引数：

• [config-path] — yaml パイプライン設定ファイルへのパスです。

オプション：

• --definition <string> — ソース、トランスフォーム、シンクを含むパイプラインの定義です。json で指定します。例： [非推奨]
• --definition-path <string> — ソース、トランスフォーム、シンクを含むパイプライン定義を記述した json/yaml ファイルへのパスです。 [非推奨]

goldsky pipeline snapshots

スナップショットに関するコマンドです。

goldsky pipeline snapshots create <nameOrConfigPath>

パイプラインのスナップショットを作成します。

引数：

• <nameOrConfigPath> — パイプライン名または設定ファイルのパスです。(必須)

goldsky pipeline snapshots list <nameOrConfigPath>

パイプラインのスナップショットを一覧表示します。

引数：

• <nameOrConfigPath> — パイプライン名または設定ファイルのパスです。(必須)

オプション：

• --version <string> — パイプラインのバージョンです。設定しない場合は、すべてのバージョンのスナップショットを返します。

---

goldsky subgraph

サブグラフに関するコマンドです。

サブコマンド

goldsky subgraph delete <nameAndVersion>

Goldsky からサブグラフを削除します。

引数：

• <nameAndVersion> — サブグラフの名前とバージョンです。例： (必須)

オプション：

• --f, -force — 確認を求めずに強制的に削除します。

goldsky subgraph deploy <nameAndVersion>

サブグラフを Goldsky にデプロイします。

引数：

• <nameAndVersion> — サブグラフの名前とバージョンです。例： (必須)

オプション：

• --path <string> — サブグラフへのパスです。
• --description <string> — サブグラフの説明またはメモです。
• --from-ipfs-hash <string> — 公開デプロイされたサブグラフの IPFS ハッシュです。
• --ipfs-gateway <string> — IPFS からサブグラフをダウンロードする際に使用する IPFS ゲートウェイです。(デフォルト： https://ipfs.network.thegraph.com)
• --from-abi <string> — ABI からサブグラフを生成します。
• --from-url <string> — 公開デプロイされたサブグラフの GraphQL エンドポイントです。
• --remove-graft — デプロイ前にサブグラフからグラフトを削除します。
• --start-block <number> — デプロイ前にサブグラフの開始ブロックを変更します。--graft-from と併用する場合、これはグラフトブロックにもなります。
• --graft-from <string> — / 形式で指定した既存のサブグラフの最新ブロックからグラフトします。
• --enable-call-handlers — コールハンドラーを有効にして、ABI からサブグラフを生成します。--from-abi と併用する場合にのみ有効です。
• --tag <string> — デプロイ後にサブグラフにタグを付けます。複数のタグはカンマ区切りで指定します。

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 を削除します

Arguments:

• <webhook-name> — 削除する Webhook の名前 (required)

Options:

• --name <string> — 削除する Webhook の名前 [deprecated]
• --f, -force — 確認を求めずに強制的に削除します

goldsky subgraph webhook list-entities <nameAndVersion>

サブグラフで使用可能な Webhook エンティティを一覧表示します

Arguments:

• <nameAndVersion> — サブグラフの名前とバージョン（例：） (required)

goldsky subgraph webhook list

Webhook を一覧表示します

---

goldsky secret

シークレット管理に関するコマンド

サブコマンド

goldsky secret create

シークレットを作成します

Options:

• --name <string> — 新しいシークレットの名前
• --value <string> — 新しいシークレットの JSON 値
• --description <string> — 新しいシークレットの説明

goldsky secret delete <name>

シークレットを削除します

Arguments:

• <name> — 削除するシークレットの名前 (required)

Options:

• --f, -force — 確認を求めずに強制的に削除します

goldsky secret list

すべてのシークレットを一覧表示します

goldsky secret reveal <name>

シークレットを表示します

Arguments:

• <name> — シークレットの名前 (required)

goldsky secret update <name>

シークレットを更新します

Arguments:

• <name> — シークレットの名前 (required)

Options:

• --value <string> — シークレットの新しい値
• --description <string> — シークレットの新しい説明

---

goldsky project

プロジェクト管理に関するコマンド

サブコマンド

goldsky project create

プロジェクトを作成します

Options:

• --name <string> — 新しいプロジェクトの名前 (required)
• --team-id <string> — プロジェクトの作成先チームの ID（現在のプロジェクトがデフォルトです

goldsky project leave

プロジェクトから退出します

Options:

• --projectId <string> — 退出するプロジェクトの ID (required)

goldsky project list

所属しているすべてのプロジェクトを一覧表示します

goldsky project update

プロジェクトを更新します

Options:

• --name <string> — プロジェクトの新しい名前 (required)

goldsky project users

プロジェクトのユーザーに関するコマンド

goldsky project users invite

プロジェクトにユーザーを招待します

Options:

• --emails <array> — 招待するユーザーのメールアドレス (required)
• --role <string> — 招待するユーザーの希望するロール (default: Viewer) (required)

goldsky project users list

このプロジェクトのすべてのユーザーを一覧表示します

goldsky project users remove

プロジェクトからユーザーを削除します

Options:

• --email <string> — 削除するユーザーのメールアドレス (required)

goldsky project users update

ユーザーを更新します

Options:

• --email <string> — 更新するユーザーのメールアドレス (required)
• --role <string> — 更新するユーザーのロール (required)

---

goldsky dataset

Goldsky データセットに関するコマンド

サブコマンド

goldsky dataset get <name>

データセットを取得します

Arguments:

• <name> — データセット名 (required)

Options:

• --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 ネットワークのみ）

Options:

• --network <string> — 同期する indexed.xyz データのネットワーク (default: sui)

goldsky indexed sync decoded-logs

ネットワークからこのコンピューターにスマートコントラクトのデコード済みログを同期します

Options:

• --contract-address <string> — 対象のコントラクトアドレス
• --network <string> — 同期する indexed.xyz データのネットワーク (default: 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 で手動インストールできます。Installation を参照してください）。マニフェストのフィールド、すべてのフラグ、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 を最新バージョンに更新します