CLI
The public product is Frothy, but the installed CLI command remains froth
during the current transition.
Identity and Naming
Frothy product / froth CLI (tooling surface)
Layer: core
Behavior: Product, docs, release assets, Homebrew formula, and VS Code surface
use Frothy / frothy; the installed released CLI binary remains froth.
Example:
froth --version
froth doctor
Core Commands
froth doctor (CLI)
Layer: core
Behavior: Checks the maintained machine and device path before you try to work
through the prompt or editor.
Example:
froth doctor
froth --port <path> doctor
froth connect (CLI)
Layer: core
Behavior: Opens the direct prompt path to the connected board. Use it when the
editor path is blocked or when you want a raw interactive session.
Example:
froth --port <path> connect
froth send (CLI)
Layer: core
Behavior: Sends source to the connected target for evaluation. This is part of
the normal live workflow, not a separate deployment-only path.
Example:
froth send src/main.froth
froth build (CLI)
Layer: core
Behavior: Builds the selected project target. This is the sanctioned project
path when you need a board build rather than only a live prompt session.
Example:
froth build
froth flash (CLI)
Layer: core
Behavior: Flashes firmware to the connected board. Use it when you need to
recover or install firmware, not as a replacement for ordinary live
redefinition.
Example:
froth --port <path> flash
Maintained Paths
attendee path versus maintainer path (tooling policy)
Layer: core
Behavior: The attendee path is intentionally narrow: released CLI, matching
VSIX, preflashed board. The maintainer path includes source builds, broader
tests, and board-target development from the repo.
Example:
make build
make test
make test-publishability