Skip to main content

​
Overview

​
Getting started

To use Goldsky, you’ll need to create an account, install the CLI, and log in. If you want to use Turbo or Compose, you’ll also need to install their respective CLI extensions.
  1. Install the Goldsky CLI: For macOS/Linux:
    For Windows:
    Windows users need to have Node.js and npm installed first. Download from nodejs.org if not already installed.
  2. Go to your Project Settings page and create an API key.
  3. Back in your Goldsky CLI, log into your Project by running the command goldsky login and paste your API key.
  4. Now that you are logged in, run goldsky to get started:
If you already have the Goldsky CLI installed, install the Turbo extension by running:
This will automatically install the Turbo extension. Verify the installation:
Make sure to update the CLI to the latest version before running Turbo commands: curl https://goldsky.com | sh
For a complete reference of all Turbo CLI commands, see the CLI Reference guide.
Compose is currently in private beta and access is invite-only. The following commands will not work unless you have been explicitly whitelisted by the Goldsky team. Enterprise customers can contact their Account Manager for expedited early access.
If you already have the Goldsky CLI installed, install the Compose extension by running:
To update to the latest version:
For more details, see the Compose quickstart guide.

​
Subgraphs

​
Mirror

​
Turbo

​
Edge RPC

​
Compose

​
Getting support

Can’t find what you’re looking for? Reach out to us at support@goldsky.com for help.