🥞 CLI Setup¶
To get started with the BeatPrints CLI, you’ll need to set up a configuration file.
Windows¶
Create a folder named
BeatPrints
in the following directory:
C:\Users\<YourUsername>\AppData\Roaming\
Inside this folder, create a file called
config.toml
with the following contents:
[general]
search_limit = 7
output_directory = "<path-to-save-your-posters>"
[credentials]
client_id = "<your-client-id>"
client_secret = "<your-client-secret>"
Replace <path-to-save-your-posters>
with the path where you’d like to save the generated posters, and fill in the client_id
and client_secret
with your Spotify credentials.
Important
If you’re using Windows, please ensure you use double backslashes (\\
) rather than a single backslash when specifying your output path. For example:
output_directory = "C:\\Users\\<YourUsername>\\Downloads\\Posters"
Linux or macOS¶
Create a folder named
BeatPrints
in your~/.config/
directory:
~/.config/BeatPrints/
Inside this folder, create a file called
config.toml
with the same contents as mentioned above.
Running the CLI¶
Once the config file is set up, you can run the BeatPrints CLI:
Open your terminal.
Type
beatprints
and press Enter.
Your poster will be saved in the output directory you specified in the config.toml
file.