Getting Started
Welcome to FlavorCLI! The following page provides instructions on how to get started using flavortown! If you haven't done so yet, please follow the Installation Instructions. Once you have installed your copy of FlavorCLI, come back here so we can get you started.
Great! So you've installed FlavorCLI, what next? The first thing you need to do is open your terminal of choice. Once you have done so, simply type in flavor and hit enter. Here you'll see all the commands you can use with FlavorCLI, along with their options. I've included documentation everywhere I can here, using the --help option, but if you still need help, you can check out the other pages of the docs here.
If you get an error similar to "The term 'flavor' is not recognized as the name of a cmdlet, function, script file, or operable program.", you do not have flavortown in your PATH variable. To add it, please follow this guide.
If you want to understand a bit more about how commands work, take a look at Commands Basics
Getting your API Key
Now, before going any further, we need to get our API key to allow FlavorCLI to interact with Flavortown on your behalf. To do this, follow these steps:
Head over to https://flavortown.hackclub.com/
Click the gear icon near your name in the sidebar
Scroll down on that menu and copy your API key.
Make sure you keep this token secret! If someone you do not trust gains access to this token, they will be able to access your entire Flavortown account. If you believe someone has gained access to your token, please regenerate it with the refresh button in the settings menu. You will have to follow the following steps again to add it back into FlavorCLI.
Adding your token to FlavorCLI
Adding your token to FlavorCLI is very simple. All you have to do is run flavor auth set <TOKEN>, with <TOKEN> being replaced with your actual token. You may delete your token from FlavorCLI at any time with flavor auth delete.
FlavorCLI will store your token securely on your device using your device's keychain. It will never store your token externally of your device, and only uses it for authenticating with API requests that you explicitly run.
Next Steps
Congratulations! You have now fully installed and set up FlavorCLI! From here, you may check out instructions on how commands work, or check out instructions on individual commands. If you ever find yourself stuck, feel free to check out these docs or use the --help option.
Last updated