Install + log in
- Create an account at app.goldsky.com.
- Create an API key on the Settings page.
- Install the Goldsky CLI:
curl -fsSL https://cli.goldsky.com/install | bash
- Log in with the API key created earlier:
Create a pipeline
Create a pipeline in one of two ways
With a guided CLI experience.
goldsky pipeline create <pipeline-name>
This will initiate an interactive CLI walkthrough that guides you through the 3-step process of creating a pipeline without any code:
- Select one or more source(s)
- Depending on the selected source(s), define transforms
- Configure one or more sink(s)
By providing a pipeline configuration file.
This is an advanced way to create a new pipeline. Instead of using the guided CLI experience (see above), you create the pipeline definition on your own. Run
goldsky pipeline create <your-pipeline-name> --definition-path ./pipeline.yamlin your terminal to create a pipeline.
A pipeline definition is a YAML structure with the following top-level properties:
sources:  transforms:  sinks: 
sinksare required with a minimum of one entry each.
transformsis optional and an empty array can be used if no transforms are needed.
Monitor a pipeline
View the status of your pipeline with the following command:
goldsky pipeline monitor <pipeline-name>
Explore other Mirror functionality through the CLI or our detailed documentation. To print the list of available commands, use:
For a full list of all available commands, use:
goldsky pipeline --help