Get started with Mirror

​

Install + log in

1. Create an account at app.goldsky.com.
2. Create an API key on the Settings page.
3. Install the Goldsky CLI:

   curl https://goldsky.com | sh
   

4. Log in with the API key created earlier:

   goldsky login
   

​

Create a pipeline

5. 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:

     1. Select one or more source(s)
     2. Depending on the selected source(s), define transforms
     3. 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.yaml in your terminal to create a pipeline.

     A pipeline definition is a YAML structure with the following top-level properties:

     sources: []
     transforms: []
     sinks: []
     

     Both sources and sinks are required with a minimum of one entry each. transforms is optional and an empty array can be used if no transforms are needed.

     For details on the pipeline definition and all available properties, please refer to the source and sink-specific documentation.

​

Monitor a pipeline

6. View the status of your pipeline with the following command:

   goldsky pipeline monitor <pipeline-name>
   

7. Explore other Mirror functionality through the CLI or our detailed documentation. To print the list of available commands, use:

   goldsky pipeline --help