Skip to main content

Install the Turbo CLI extension

If you already have the Goldsky CLI installed, you’ll just need to install the Turbo extension.
Please make sure to update the CLI to the latest version in order to run Turbo comands. curl https://goldsky.com | sh
goldsky turbo

If you don’t already have the Goldsky CLI installed, you’ll need to start by installing that, then run the above command.

For macOS/Linux:
curl https://goldsky.com | sh
For Windows:
npm install -g @goldskycom/cli
Windows users need to have Node.js and npm installed first. Download from nodejs.org if not already installed.
Verify the installation:
goldsky turbo list

Authentication

The Turbo Pipelines CLI uses your Goldsky credentials. Make sure you’re logged in:
goldsky login
The CLI automatically falls back to Goldsky commands for authentication, project management, and secret management.

Basic Commands

Apply a Pipeline

Deploy a pipeline from a YAML configuration file:
goldsky turbo apply my-pipeline.yaml
This command will:
  • Validate your pipeline configuration
  • Create or update the pipeline in your current project
  • Start processing data according to your configuration
If there were existing pipelines with the same name, the checkpoints from those pipelines will be reused.
To have a pipeline restart from scratch, you will have to rename the pipeline or rename the specific source node to avoid using the existing checkpoints.

List Pipelines

View all pipelines in your current project:
goldsky turbo list

Delete a Pipeline

Remove a pipeline by name:
goldsky turbo delete my-pipeline
Or delete using the YAML file:
goldsky turbo delete -f my-pipeline.yaml

Validate a Pipeline

Check your pipeline configuration without deploying:
goldsky turbo validate my-pipeline.yaml
This is useful for:
  • Catching syntax errors before deployment
  • Verifying source and sink configurations
  • Testing transform logic

Viewing Logs

Monitor your pipeline’s execution with the logs command:
# View recent logs (default: last 10 lines)
goldsky turbo logs my-pipeline

# Show last 50 lines
goldsky turbo logs my-pipeline --tail 50

# Show logs from last hour
goldsky turbo logs my-pipeline --since 3600

# Include timestamps
goldsky turbo logs my-pipeline --timestamps
Use --follow to monitor your pipeline in real-time, especially useful when debugging or watching data flow through transforms.

Inspecting Live Data

View live data samples flowing through your pipeline:
# Inspect all nodes in a pipeline
goldsky turbo inspect my-pipeline

# Filter to specific topology nodes
goldsky turbo inspect my-pipeline -n source1,transform1

# Use a pipeline configuration file
goldsky turbo inspect my-pipeline.yaml
Live Inspect shows real-time data samples from each topology node (sources, transforms, and sinks), making it easy to debug transformations and verify data flow.
For detailed information about Live Inspect, including configuration options and best practices, see the Live Inspect guide.

Managing Projects and Secrets

The Turbo Pipelines CLI integrates with the Goldsky CLI for project and secret management:

Projects

# List all projects
goldsky turbo project list

# Switch to a different project
goldsky turbo project use my-project

Secrets

Secrets are used to store sensitive configuration like database credentials:
# Create a secret
goldsky secret create MY_POSTGRES_SECRET

# List secrets
goldsky secret list

# Delete a secret
goldsky secret delete MY_POSTGRES_SECRET
Secrets are referenced in your pipeline YAML using the secret_name field. See the Pipeline Configuration guide for examples.

Next Steps