> For the complete documentation index, see [llms.txt](https://docs.spotify-sync.jbh.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spotify-sync.jbh.cloud/home/quick-start.md).

# Quick start

## Prerequisites

* Python >= 3.8 & pip
* Spotify account (free or premium)
* Deezer account (free or premium)

## Install

> python3 -m pip install -U spot\_sync

You should now be able to reference via `spotify_sync`. However if you aren't it's possible you need to add package install directory to your $PATH. E.g. `pip3 show spot-sync | grep Location`

## Configure

Generate a new config

> spotify\_sync config generate

Configure config.json as per [Schema](/configuration/schema.md)

(Optional) Add config to the profile cache

> spotify\_sync config add myFirstProfile ./config.json

## Run

Allow spotify\_sync to connect to your Spotify account

> spotify\_sync utils authorize-spotify --profile myFirstProfile

{% hint style="info" %}
This will direct you to Spotify to authorize the app you created earlier. After you confirm, the url you are directed to will not 'work'. This is expected, copy the url and paste back into the CLI
{% endhint %}

Start spotify\_sync! 

> spotify\_sync run auto --profile myFirstProfile

{% hint style="info" %}
Any command that accepts a --profile argument also accepts --config instead:

*spotify\_sync utils authorize-spotify --config /path/to/config.json*
{% endhint %}

{% hint style="warning" %}
If you have a large Spotify library (or are downloading many followed playlists) this first run could take a long time. This is a limit with the Deezer API used to match songs
{% endhint %}

### Other run modes

```
spotify_sync --help

Usage: spotify_sync [OPTIONS] COMMAND [ARGS]...

  spotify_sync
  A schedulable, configurable CLI downloader for Spotify accounts 

Options:
  --help  Show this message and exit.
  
Commands:
  backup   Backup config and persistent data
  config   Access app configurations
  restore  Restore an existing backup
  run      Run spotify_sync in different modes
  stats    Display stats from various sources
  utils    Helper commands
```