Skip to content

Commands

Akash R Chandran edited this page Jan 13, 2023 · 3 revisions

The available commands are listed below. You can can view the help for command line arguments by using help argument.

syrics --help

Output:

usage: syrics.exe [-h] [-d PATH] [-f BOOLEAN] [-c [CONFIG]] [-u [{current,album,play}]] [URL]

positional arguments:
  URL                   url of song, album or playlist from spotify.

options:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        give path to download directory.
  -f BOOLEAN, --force BOOLEAN
                        Skip check for if it already downloader and available in directory.
  -c [CONFIG], --config [CONFIG]
                        edit config file or reset it.
  -u [{current,album,play}], --user [{current,album,play}]
                        items to download from users account like playlist, tracks etc.

Config

When you run the program for the first time, it will directly create config and open editing.

To edit config

syrics --config

To reset config to default values

syrics --config reset

To open config in notepad or nano text editors

syrics --config open

After finding sp_dc you should edit config file and set sp_dc to the value you found.

Default values of config

{
    "sp_dc": "",
    "download_path": "downloads",
    "create_folder": true,
    "album_folder_name": "{name} - {artists}",
    "play_folder_name": "{name} - {owner}",
    "file_name": "{track_number}. {name}",
    "synced_lyrics": true,
    "force_download": false,
    "force_synced": false
}

Usage

Make sure you have set the config before starting.

1. Direct

syrics
Enter link: https://open.spotify.com/track/2eAvDnpXP5W0cVtiI0PUxV

Enter syrics on the terminal and it will ask for the link

2. Passing link as commandline argument

syrics https://open.spotify.com/track/2eAvDnpXP5W0cVtiI0PUxV

changing download folder command

syrics --directory ~/Music/songs/ https://open.spotify.com/track/2eAvDnpXP5W0cVtiI0PUxV

download current playing song on authorized account

syrics --user current-playing

downloading from user playlist on authorized account

syrics --user playlist

downloading from user album on authorized account

syrics --user album

3. Passing Folder path with music files (Experimental)

syrics /home/public_user/Music/songs