# README

![FlavorCLI Banner](https://hc-cdn.hel1.your-objectstorage.com/s/v3/d80496dcf9688766_untitled__1_.png)

> \[!TIP] This page best viewed on [GitBook](https://flavorcli.gitbook.io/flavorcli)! We highly recommend reading the docs there, as some formatting does not work in raw markdown properly, and it provides for easier navigation.

Welcome to the FlavorCLI docs! Here you may find all the information you need to use FlavorCLI. To get started, take a look at the **Table of Contents** on the left. There you may find guides on many commands and concepts.

### Quick Links

> **Important!** If you are viewing this README on Flavortown, you **will not** be able to see the quick links or the table of contents! Please view this page on [GitBook](https://flavorcli.gitbook.io/flavorcli)! <https://flavorcli.gitbook.io/flavorcli>

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Install FlavorCLI on your system</td><td><a href="/pages/HvCveLKZNTNMLUAA6K9j">/pages/HvCveLKZNTNMLUAA6K9j</a></td></tr><tr><td><strong>Getting Started</strong></td><td>Setup and basic usage</td><td><a href="/pages/xfvRMQdoCmNmaqOxqww4">/pages/xfvRMQdoCmNmaqOxqww4</a></td></tr><tr><td><strong>Add to PATH</strong></td><td>Make FlavorCLI available everywhere</td><td><a href="/pages/15wFfi6OVI2OI20fQlWt">/pages/15wFfi6OVI2OI20fQlWt</a></td></tr><tr><td><strong>Command Basics</strong></td><td>How commands and arguments work</td><td><a href="/pages/OnTmNAA77kAKJLmVRoZQ">/pages/OnTmNAA77kAKJLmVRoZQ</a></td></tr><tr><td><strong>Auth Commands</strong></td><td>Authenticate with the Flavortown API</td><td><a href="/pages/9BmlnpwmfWh70PA3fjFv">/pages/9BmlnpwmfWh70PA3fjFv</a></td></tr><tr><td><strong>Project Commands</strong></td><td>Create, update, and manage projects and devlogs</td><td><a href="/pages/XLYCYcHGXBRWvizvI8RL">/pages/XLYCYcHGXBRWvizvI8RL</a></td></tr><tr><td><strong>Store Commands</strong></td><td>Browse and query the store</td><td><a href="/pages/ddpEKURxz0JOhEylDewF">/pages/ddpEKURxz0JOhEylDewF</a></td></tr><tr><td><strong>User Commands</strong></td><td>Fetch and list user information</td><td><a href="/pages/QyoyL4nhtbpASauVXBTV">/pages/QyoyL4nhtbpASauVXBTV</a></td></tr></tbody></table>

### Definitions

For the purpose of these docs, the following definitions will be used:

* **Commands** - Any action noun keyword that is used in the CLI to do things. I.E `flavor user get`, where `get` is the command. For disambiguation, `user get` may be referred to as the command.
* **Subcommands** - Any noun keyword that is used to split up commands. I.E `flavor user get`, where `user` is the subcommand.
* **Options** - Any option for a command that is prefixed with a single `-` (short options) or a double `--` (long options). I.E `flavor user get --help` where `--help` is the option. This includes options that accept values, like `flavor project create --title "cool project"`.
* **Arguments** - Any option for a command that *is not* prefixed with a `-` or `--`. I.E `flavor user get 190`, where `190` is the option.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://flavorcli.gitbook.io/flavorcli-docs/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.