Goldsky CLI Reference
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 login / logout
- — Authenticate with Goldsky
- — Remove stored credentials
goldsky turbo
Manages Turbo streaming pipelines. Delegates to the
binary.
Subcommands
Apply a pipeline definition from YAML file
Delete a pipeline by name
Pause a pipeline by name
Resume a paused pipeline by name
List all pipelines in the current project
Stream logs from a pipeline
Validate a pipeline definition without applying it
Inspect live data flowing through a pipeline
Get pipeline details
Manage pipeline state
goldsky pipeline
Commands related to Goldsky pipelines
Subcommands
goldsky pipeline apply <config-path>
Apply the provided pipeline yaml config. This command creates the pipeline if it doesn
Arguments:
- — path to the yaml pipeline config file. (required)
Options:
- — Snapshot that will be used to start the pipeline. Applicable values are:
- — 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 [deprecated]
- — attempts to use the latest available snapshot.
- — Status of the pipeline
- — Forces apply without any prompts, useful for using apply in CI
goldsky pipeline cancel-update <nameOrConfigPath>
Cancel in-flight update request
Arguments:
- — pipeline name or config file path (required)
goldsky pipeline create <name>
Create a pipeline
Arguments:
- — name of the new pipeline (required)
Options:
--output, -outputFormat <string>
--resource-size, -resourceSize <string>
--skip-transform-validation
- — the description of the new pipeline
- — definition of the pipeline that includes sources, transforms, sinks. Provided as json eg:
--definition-path <string>
- — the desired status of the pipeline (default: ACTIVE)
- — Whether the pipeline should use dedicated egress IPs (required)
goldsky pipeline delete <nameOrConfigPath>
Delete a pipeline
Arguments:
- — pipeline name or config file path (required)
Options:
- — Force the deletion without prompting for confirmation
goldsky pipeline export [name]
Export pipeline configurations
Arguments:
Options:
- — Export pipeline configurations for all available pipelines
goldsky pipeline get-definition <name>
Arguments:
- — pipeline name (required)
Options:
--outputFormat, -output <string>
goldsky pipeline get <nameOrConfigPath>
Get a pipeline
Arguments:
- — pipeline name or config file path (required)
Options:
--outputFormat, -output <string>
- — print the pipeline
- — pipeline version. Returns latest version of the pipeline if not set.
goldsky pipeline info <nameOrConfigPath>
Display pipeline information
Arguments:
- — pipeline name or config file path (required)
Options:
- — pipeline version. Returns latest version of the pipeline if not set.
List all pipelines
Options:
--output, -outputFormat <string>
--outputVerbosity <string>
--include-runtime-details
goldsky pipeline monitor <nameOrConfigPath>
Monitor a pipeline runtime
Arguments:
- — pipeline name or config file path (required)
Options:
- — pipeline version, uses latest version if not set.
- — monitor update request
--max-refreshes, -maxRefreshes <number>
goldsky pipeline pause <nameOrConfigPath>
Pause a pipeline
Arguments:
- — pipeline name or config file path (required)
goldsky pipeline resize <nameOrConfigPath> <resourceSize>
Resize a pipeline
Arguments:
- — pipeline name or config file path (required)
- — runtime resource size (required)
goldsky pipeline restart <nameOrConfigPath>
Restart a pipeline. Useful in scenarios where pipeline needs to be restarted without any configuration changes.
Arguments:
- — pipeline name or config path (required)
Options:
- — Snapshot that will be used to start the pipeline. Applicable values are: (required)
- — Disables monitoring after the command is run. Defaults to false.
goldsky pipeline start <nameOrConfigPath>
Start a pipeline
Arguments:
- — pipeline name or config path (required)
Options:
- — attempts to use the latest available snapshot.
- — Snapshot that will be used to start the pipeline. Applicable values are:
goldsky pipeline stop <nameOrConfigPath>
Stop a pipeline
Arguments:
- — pipeline name or config file path (required)
goldsky pipeline update <name>
Arguments:
- — name of the pipeline to update. (required)
Options:
--outputFormat, -output <string>
--resource-size, -resourceSize <string>
- — status of the pipeline
- — 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
- — attempts to use the latest available snapshot.
- — definition of the pipeline that includes sources, transforms, sinks. Provided as json eg:
--definition-path <string>
- — description of the pipeline
goldsky pipeline validate [config-path]
Validate a pipeline definition or config.
Arguments:
- — path to the yaml pipeline config file.
Options:
- — definition of the pipeline that includes sources, transforms, sinks. Provided as json eg: [deprecated]
--definition-path <string>
goldsky pipeline snapshots
Commands related to snapshots
goldsky pipeline snapshots create <nameOrConfigPath>
Attempts to take a snapshot of the pipeline
Arguments:
- — pipeline name or config file path (required)
goldsky pipeline snapshots list <nameOrConfigPath>
List snapshots in a pipeline
Arguments:
- — pipeline name or config file path (required)
Options:
- — pipeline version. Returns snapshots across all versions if not set.
goldsky subgraph
Commands related to subgraphs
Subcommands
goldsky subgraph delete <nameAndVersion>
Delete a subgraph from Goldsky
Arguments:
- — Name and version of the subgraph, e.g. (required)
Options:
- — Force the deletion without prompting for confirmation
goldsky subgraph deploy <nameAndVersion>
Deploy a subgraph to Goldsky
Arguments:
- — Name and version of the subgraph, e.g. (required)
Options:
- — Path to subgraph
- — Description/notes for the subgraph
--from-ipfs-hash <string>
- — IPFS gateway to use if downloading the subgraph from IPFS (default: https://ipfs.network.thegraph.com)
- — Generate a subgraph from an ABI
- — GraphQL endpoint for a publicly deployed subgraph
- — Remove grafts from the subgraph prior to deployment
- — 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 the latest block of an existing subgraph in the format <name>/<version>
- — Generate a subgraph from an ABI with call handlers enabled. Only meaningful when used with --from-abi
- — Tag the subgraph after deployment, comma separated for multiple tags
goldsky subgraph init [nameAndVersion]
Initialize a new subgraph project with basic scaffolding
Arguments:
- — Name and version of the subgraph, e.g.
Options:
- — Target path to write subgraph files to
- — Overwrite existing files at the target path
- — Path to instant subgraph JSON configuration file
- — ABI source(s) for contract(s)
- — Contract address(es) to watch for events
--contract-events <string>
--contract-calls <string>
- — Name of the contract(s)
- — Block to start at for a contract on a specific network
- — Subgraph description
- — Enable call handlers for the subgraph
- — Build the subgraph after writing files
- — Deploy the subgraph after build
goldsky subgraph list [nameAndVersion]
View deployed subgraphs and tags
Arguments:
- — Name and version of the subgraph, e.g.
Options:
- — Limit results to just tags or deployments (choices: tags, deployments)
- — Summarize subgraphs & versions without all their details
goldsky subgraph log <nameAndVersion>
Tail a subgraph
Arguments:
- — Name and version of the subgraph, e.g. (required)
Options:
- — Return logs newer than a relative duration like now, 5s, 2m, or 3h (default: 1m)
- — 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)
- — The minimum log level to output (default: info)
- — The explicit comma separated log levels to include (${SubgraphApi.SubgraphLogLevels.join(
- — The time in seconds to wait between checking for new logs (default: 5)
goldsky subgraph pause <nameAndVersion>
Pause a subgraph
Arguments:
- — Name and version of the subgraph, e.g. (required)
goldsky subgraph start <nameAndVersion>
Start a subgraph
Arguments:
- — Name and version of the subgraph, e.g. (required)
goldsky subgraph update <nameAndVersion>
Update a subgraph
Arguments:
- — Name and version of the subgraph, e.g. (required)
Options:
--public-endpoint <string>
--private-endpoint <string>
- — Description/notes for the subgraph
Commands related to tags
goldsky subgraph tag create <nameAndVersion>
Create a new tag
Arguments:
- — Name and version of the subgraph, e.g. (required)
Options:
- — The name of the tag (required)
goldsky subgraph tag delete <nameAndVersion>
Delete a tag
Arguments:
- — Name and version of the subgraph, e.g. (required)
Options:
- — The name of the tag to delete (required)
- — Force the deletion without prompting for confirmation
Commands related to webhooks
goldsky subgraph webhook create <nameAndVersion>
Create a webhook
Arguments:
- — Name and version of the subgraph, e.g. (required)
Options:
- — Name of the webhook, must be unique (required)
- — URL to send events to (required)
- — Subgraph entity to send events for (required)
- — The secret you will receive with each webhook request Goldsky sends
goldsky subgraph webhook delete [webhook-name]
Delete a webhook
Arguments:
- — Name of the webhook to delete (required)
Options:
- — Name of the webhook to delete [deprecated]
- — Force the deletion without prompting for confirmation
goldsky subgraph webhook list-entities <nameAndVersion>
List possible webhook entities for a subgraph
Arguments:
- — Name and version of the subgraph, e.g. (required)
goldsky subgraph webhook list
List webhooks
goldsky secret
Commands related to secret management
Subcommands
create a secret
Options:
- — the name of the new secret
- — the value of the new secret in json
- — the description of the new secret
goldsky secret delete <name>
delete a secret
Arguments:
- — the name of the secret to delete (required)
Options:
- — Force the deletion without prompting for confirmation
list all secrets
goldsky secret reveal <name>
reveal a secret
Arguments:
- — the name of the secret (required)
goldsky secret update <name>
update a secret
Arguments:
- — the name of the secret (required)
Options:
- — the new value of the secret
- — the new description of the secret
goldsky project
Commands related to project management
Subcommands
Create a project
Options:
- — the name of the new project (required)
- — the ID of the team to create the project in (defaults to current project
Leave a project
Options:
- — the ID of the project you want to leave (required)
List all of the projects you belong to
Update a project
Options:
- — the new name of the project (required)
Commands related to the users of a project
goldsky project users invite
Invite a user to your project
Options:
- — emails of users to invite (required)
- — desired role of invited user(s) (default: Viewer) (required)
goldsky project users list
List all users for this project
goldsky project users remove
Remove a user from your project
Options:
- — email of user to remove (required)
goldsky project users update
Update a user
Options:
- — email of user to remove (required)
- — role of user to update (required)
goldsky dataset
Commands related to Goldsky datasets
Subcommands
goldsky dataset get <name>
Get a dataset
Arguments:
- — dataset name (required)
Options:
- — dataset version
- — the output format. Either json or yaml. Defaults to yaml
List datasets
goldsky indexed
Analyze blockchain data with indexed.xyz
Subcommands
Analyze indexed.xyz data with Rill
Commands related to syncing indexed.xyz real-time raw & decoded crypto datasets
goldsky indexed sync checkpoints
Sync checkpoints (Sui network only)
Options:
- — The network of indexed.xyz data to synchronize (default: sui)
goldsky indexed sync decoded-logs
Sync decoded logs for a smart contract from a network to this computer
Options:
--contract-address <string>
- — The network of indexed.xyz data to synchronize (default: ethereum)
goldsky indexed sync events
Sync events (Sui network only)
Options:
- — The network of indexed.xyz data to synchronize (default: sui)
goldsky indexed sync move-calls
Sync Move function calls (Sui network only)
Options:
- — The network of indexed.xyz data to synchronize (default: sui)
goldsky indexed sync packages
Sync packages (Sui network only)
Options:
- — The network of indexed.xyz data to synchronize (default: sui)
goldsky indexed sync raw-blocks
Sync all blocks from a network
Options:
- — The network of indexed.xyz data to synchronize (default: ethereum)
goldsky indexed sync raw-logs
Sync all logs from a network
Options:
--contract-address <string>
- — The network of indexed.xyz data to synchronize (default: ethereum)
goldsky indexed sync raw-transactions
Sync all transactions from a network
Options:
- — The network of indexed.xyz data to synchronize (default: ethereum)
goldsky indexed sync sui-transactions
Sync transactions (Sui network only)
Options:
- — The network of indexed.xyz data to synchronize (default: sui)
goldsky indexed sync transaction-objects
Sync transaction objects (Sui network only)
Options:
- — The network of indexed.xyz data to synchronize (default: sui)
goldsky telemetry
Commands related to CLI telemetry
Subcommands
goldsky telemetry disable
Disable anonymous CLI telemetry
Enable anonymous CLI telemetry
Display the CLI telemetry status