Skip to main content

​
Overview

In order for Goldsky to connect to your sink, you have to configure secrets. Secrets refer to your datastore credentials which are securely stored in your Goldsky account. You can create and manage your secrets with the goldsky secret command. To see a list of available commands and how to use them, please refer to the output of goldsky secret -h. For sink-specific secret information, please refer to the individual sink pages.

​
Guided CLI experience

If you create a pipeline with goldsky pipeline create <pipeline-name>, there is no need to create a secret beforehand. The CLI will list existing secrets and offer you the option of creating a new secret as part of the pipeline creation flow.

​
The --value flag expects JSON

goldsky secret create --value treats its payload as JSON so a single secret can hold the structured credentials most sinks require (host, port, username, password, etc.). Every sink example on this site passes a JSON object to --value for that reason — for example:
See each sink page for the exact schema its secret expects. Wrap the argument in single quotes so the shell does not strip the inner double quotes. If your secret is a single plain value (an API token, a URL, a connection string) and you would rather not hand-craft JSON, run goldsky secret create with no flags — the interactive prompts accept a plain string and the CLI encodes it correctly.

Related topics

Create a cross-chain subgraphClickHouseMySQLPostgreSQLCLI Reference