diff --git a/Arguments.md b/Arguments.md new file mode 100644 index 0000000..b61b40b --- /dev/null +++ b/Arguments.md @@ -0,0 +1,54 @@ +## Authentication +### Spotify Client ID +Sets the Spotify Client ID used to authenticate to Spotify +| Usage | --spotifyclient | +|-----------|-------------------| +| Required? | ✔ | +| Aliases | -sClient, -sC | + +### Spotify Client Secret +Sets the Spotify Client Secret used to authenticate to Spotify +| Usage | --spotifysecret | +|-----------|-------------------| +| Required? | ✔ | +| Aliases | -sSecret, -sS | + +### LastFM API Key +Sets the LastFM API Key used to authenticate to LastFM +| Usage | --lastfmtoken | +|-----------|-------------------| +| Required? | ✔ | +| Aliases | -lToken, -lT | + +### LastFM Username +Sets the LastFM username from which to pull the data +| Usage | --lastfmuser | +|-----------|-------------------| +| Required? | ✔ | +| Aliases | -lUser, -lU | + +## Personalization + +## Data period selection + +## Others +### Help +Shows a list of all commands or, if provided, help for a given command. +| Usage | --help [argument] | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -h, -? | + +### Loglevel +Sets the loglevel. May flood the console. Use carefully. +Possible loglevels: + - 0: Quiet Will run completely quietly + - 1: Default Will only show progress + - 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] | +|-----------|-------------------| +| Required? | ❌ | +| Aliases | -log, -l | +