CLI

The Floe command line interface (CLI) is the fastest way to get started with Floe.

Commands

Initializes a new Floe project in the current directory. This will create a .floe/config.json file in the current directory.

floe init

Reviews content and provides feedback based on changes between commits (git diff).

floe review diff [arguments]

Argument	Description	Default
`[diff]`	The diff to compare.	`HEAD`

Option	Description	Default
`--fix <fix>`	Enables 'fix mode'. Allows the user to step through issues and accept or deny suggested changes.	`false`
`--model <model>`	Set to `pro` or `basic` to specify which type of tokens to use.	`pro`

# Review the diff between the current commit and the previous commit
floe review diff HEAD~1

Reviews content and provides feedback for entire files.

floe review files [arguments] [options]

Argument	Description	Default
`[files...]`	A space separated list of glob patterns to evaluate.	`include` glob pattern specified in each `ruleset`

Option	Description	Default
`--ignore <ignore...>`	A space separated list of glob patterns to ignore.
`--fix <fix>`	Enables 'fix mode'. Allows the user to step through issues and accept or deny suggested changes.	`false`
`--ruleset <ruleset>`	Only evaluate against the specified ruleset.	All rulesets
`--model <model>`	Set to `pro` or `basic` to specify which type of tokens to use.	`pro`

# Review the diff between the current commit and the previous commit
floe review files 'apps/docs/**' --ignore 'apps/docs/README.md'