Updated Arguments (markdown)
86
Arguments.md
86
Arguments.md
@@ -1,35 +1,101 @@
|
|||||||
## Authentication
|
## Authentication
|
||||||
### Spotify Client ID
|
### Spotify Client ID
|
||||||
Sets the Spotify Client ID used to authenticate to Spotify
|
Sets the Spotify Client ID used to authenticate to Spotify
|
||||||
| Usage | --spotifyclient <clientid> |
|
| Usage | --spotifyclient \<clientid\> |
|
||||||
|-----------|-------------------|
|
|-----------|-------------------|
|
||||||
| Required? | ✔ |
|
| Required? | ✔ |
|
||||||
| Aliases | -sClient, -sC |
|
| Aliases | -sClient, -sC |
|
||||||
|
|
||||||
### Spotify Client Secret
|
### Spotify Client Secret
|
||||||
Sets the Spotify Client Secret used to authenticate to Spotify
|
Sets the Spotify Client Secret used to authenticate to Spotify
|
||||||
| Usage | --spotifysecret <clientsecret> |
|
| Usage | --spotifysecret \<clientsecret\> |
|
||||||
|-----------|-------------------|
|
|-----------|-------------------|
|
||||||
| Required? | ✔ |
|
| Required? | ✔ |
|
||||||
| Aliases | -sSecret, -sS |
|
| Aliases | -sSecret, -sS |
|
||||||
|
|
||||||
### LastFM API Key
|
### LastFM API Key
|
||||||
Sets the LastFM API Key used to authenticate to LastFM
|
Sets the LastFM API Key used to authenticate to LastFM
|
||||||
| Usage | --lastfmtoken <apitoken> |
|
| Usage | --lastfmtoken \<apitoken\> |
|
||||||
|-----------|-------------------|
|
|-----------|-------------------|
|
||||||
| Required? | ✔ |
|
| Required? | ✔ |
|
||||||
| Aliases | -lToken, -lT |
|
| Aliases | -lToken, -lT |
|
||||||
|
|
||||||
### LastFM Username
|
### LastFM Username
|
||||||
Sets the LastFM username from which to pull the data
|
Sets the LastFM username from which to pull the data
|
||||||
| Usage | --lastfmuser <username> |
|
| Usage | --lastfmuser \<username\> |
|
||||||
|-----------|-------------------|
|
|-----------|-------------------|
|
||||||
| Required? | ✔ |
|
| Required? | ✔ |
|
||||||
| Aliases | -lUser, -lU |
|
| Aliases | -lUser, -lU |
|
||||||
|
|
||||||
## Personalization
|
|
||||||
|
|
||||||
## Data period selection
|
## Personalization
|
||||||
|
### Cover Art
|
||||||
|
Selects a .jpeg file to upload as cover art
|
||||||
|
| Usage | --coverart \<path/to/file.jpg\> |
|
||||||
|
|-----------|-------------------|
|
||||||
|
| 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 \<name\> |
|
||||||
|
|-----------|-------------------|
|
||||||
|
| 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
|
## Others
|
||||||
### Help
|
### Help
|
||||||
@@ -47,8 +113,14 @@ Possible loglevels:
|
|||||||
- 2: Verbose Will echo current step being worked on
|
- 2: Verbose Will echo current step being worked on
|
||||||
- 3: Debug Will give specific information on what excactly the tool is doing
|
- 3: Debug Will give specific information on what excactly the tool is doing
|
||||||
|
|
||||||
| Usage | --loglevel [loglevel] |
|
| Usage | --loglevel \<loglevel\> |
|
||||||
|-----------|-------------------|
|
|-----------|-------------------|
|
||||||
| Required? | ❌ |
|
| Required? | ❌ |
|
||||||
| Aliases | -log, -l |
|
| 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 \<password\> |
|
||||||
|
|-----------|-------------------|
|
||||||
|
| Required? | ❌ |
|
||||||
|
| Aliases | -sTk |
|
||||||
Reference in New Issue
Block a user