README

FlavorCLI Banner

[!TIP] This page best viewed on GitBook! 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

Installation

Install FlavorCLI on your system

Getting Started

Setup and basic usage

Add to PATH

Make FlavorCLI available everywhere

Command Basics

How commands and arguments work

Auth Commands

Authenticate with the Flavortown API

Project Commands

Create, update, and manage projects and devlogs

Store Commands

Browse and query the store

User Commands

Fetch and list user information

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.