Skip to content

Quick Start

This guide will walk you through authenticating and running your first pipeline with the CLI.

Before running pipelines, authenticate with Spotify:

Terminal window
plpl auth login

This will open a browser window for Spotify authentication. Your credentials are stored locally.

To check your authentication status:

Terminal window
plpl auth status

Create a pipeline definition file in YAML format:

my-pipeline.yaml
name: My First Pipeline
tasks:
- type: getPlaylistTracks
playlistId: "37i9dQZF1DXcBWIGoYBM5M" # Today's Top Hits
- type: shuffleTracks
- type: limitTracks
limit: 25
- type: saveToPlaylist
playlistId: "your-playlist-id"
Terminal window
plpl run my-pipeline.yaml

Preview what the pipeline would do without making changes:

Terminal window
plpl run my-pipeline.yaml --dry-run

See detailed output for debugging:

Terminal window
plpl run my-pipeline.yaml --verbose
  • Learn about Tasks to understand what operations are available
  • Explore Providers to see where you can source tracks from