diff --git a/Arguments.md b/Arguments.md index b61b40b..34cc5ac 100644 --- a/Arguments.md +++ b/Arguments.md @@ -1,35 +1,101 @@ ## Authentication ### Spotify Client ID Sets the Spotify Client ID used to authenticate to Spotify -| Usage | --spotifyclient | +| Usage | --spotifyclient \ | |-----------|-------------------| | Required? | ✔ | | Aliases | -sClient, -sC | ### Spotify Client Secret Sets the Spotify Client Secret used to authenticate to Spotify -| Usage | --spotifysecret | +| Usage | --spotifysecret \ | |-----------|-------------------| | Required? | ✔ | | Aliases | -sSecret, -sS | ### LastFM API Key Sets the LastFM API Key used to authenticate to LastFM -| Usage | --lastfmtoken | +| Usage | --lastfmtoken \ | |-----------|-------------------| | Required? | ✔ | | Aliases | -lToken, -lT | ### LastFM Username Sets the LastFM username from which to pull the data -| Usage | --lastfmuser | +| Usage | --lastfmuser \ | |-----------|-------------------| | Required? | ✔ | | Aliases | -lUser, -lU | -## Personalization -## Data period selection +## Personalization +### Cover Art +Selects a .jpeg file to upload as cover art +| Usage | --coverart \ | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -ca, -cover | + +### Playlist Name +Selects a name for the created playlist. Supports templating. Refer to [[Filename Templating]] for information on file name templates. +| Usage | --playlistname \ | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -pN, -pName | + + +## Access modifiers (select only one) +### Public +Makes the playlist show on your profile. +| Usage | --public | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -pP | + +### Public +Makes the playlist collaborative. +| Usage | --collaborative | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -pC | + + +## Data period selection (select only one) +### Weekly +Sets the data selection period to one week. +| Usage | --weekly | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -W | + +### Monthly +Sets the data selection period to one month. +| Usage | --monthly | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -M | + +### Quarterly +Sets the data selection period to three months. +| Usage | --quarterly| +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -Q | + +### Biannually +Sets the data selection period to six months. +| Usage | --biannually| +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -B | + +### Annually +Sets the data selection period to one year. +| Usage | --annually | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -A | + ## Others ### Help @@ -47,8 +113,14 @@ Possible loglevels: - 2: Verbose Will echo current step being worked on - 3: Debug Will give specific information on what excactly the tool is doing -| Usage | --loglevel [loglevel] | +| Usage | --loglevel \ | |-----------|-------------------| | Required? | ❌ | | Aliases | -log, -l | +### Spotify Access Token Caching +Caches the access token and corresponding refresh token into an encrypted file saved at "~/.lfm2s/spotify.lfm2scred". The secret key for the encryption is generated from the password. +| Usage | --spotifycache \ | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -sTk | \ No newline at end of file