Updated Arguments (markdown)

Alix von Schirp
2023-01-28 07:17:50 +01:00
parent 142220c6fc
commit 141620f0fd

@@ -1,35 +1,101 @@
## Authentication
### Spotify Client ID
Sets the Spotify Client ID used to authenticate to Spotify
| Usage | --spotifyclient <clientid> |
| Usage | --spotifyclient \<clientid\> |
|-----------|-------------------|
| Required? | ✔ |
| Aliases | -sClient, -sC |
### Spotify Client Secret
Sets the Spotify Client Secret used to authenticate to Spotify
| Usage | --spotifysecret <clientsecret> |
| Usage | --spotifysecret \<clientsecret\> |
|-----------|-------------------|
| Required? | ✔ |
| Aliases | -sSecret, -sS |
### LastFM API Key
Sets the LastFM API Key used to authenticate to LastFM
| Usage | --lastfmtoken <apitoken> |
| Usage | --lastfmtoken \<apitoken\> |
|-----------|-------------------|
| Required? | ✔ |
| Aliases | -lToken, -lT |
### LastFM Username
Sets the LastFM username from which to pull the data
| Usage | --lastfmuser <username> |
| Usage | --lastfmuser \<username\> |
|-----------|-------------------|
| Required? | ✔ |
| 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
### 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 \<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 \<password\> |
|-----------|-------------------|
| Required? | ❌ |
| Aliases | -sTk |