Get started with Mirror
5-minute walkthrough to get data streaming into your own infra.
Install + log in
- Install the Goldsky CLI:
- Go to your Project Settings page and create an API key.
- Back in your Goldsky CLI, log into your Project by running the command
goldsky login
and paste your API key. - Now that you are logged in, run
goldsky
to get started:
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 configuration on your own.
Create a pipeline configuration YAML file:
Both
sources
andsinks
are required with a minimum of one entry each.transforms
is optional and an empty object ({}
) can be used if no transforms are needed.For details on the pipeline configuration YAML and all available properties, please refer to the source and sink-specific documentation.
Run
goldsky pipeline apply <your-pipeline-config-file-path>
in your terminal to create a pipeline.
-
Monitor a pipeline
-
View the status of your pipeline with the following command:
-
Explore other Mirror functionality through the CLI or our detailed documentation. To print the list of available commands, use:
Was this page helpful?