Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goldsky.com/llms.txt

Use this file to discover all available pages before exploring further.

The Goldsky CLI is the primary tool for deploying and managing subgraphs, Mirror pipelines, and Turbo pipelines.

Install the CLI

For macOS/Linux:
curl https://goldsky.com | sh
For Windows:
npm install -g @goldskycom/cli
Windows users need to have Node.js and npm installed first. Download from nodejs.org if not already installed.

Verify Installation

After installation, verify the CLI is working:
goldsky --version

Next Steps

After installing the CLI, you’ll need to authenticate:
goldsky login
This will open your browser to complete authentication with your Goldsky account.

Deploy a Subgraph

Get started with subgraph indexing

Create a Mirror Pipeline

Stream blockchain data to your database

Build with Turbo

High-performance data processing

CLI Reference

Explore all CLI commands