FluttyUI Logo
FluttyUI
API References

Flutty CLI

CLI command reference for Flutty.

Reference for the flutty command.

Once installed, use:

flutty <command> [arguments]

Global options

OptionTypeDescription
--help, -hboolShow CLI help
--version, -vboolShow CLI version

Commands

init

Create a new Flutty project scaffold.

flutty init <project_name> [options]

Options

OptionTypeDefaultNotes
--template, -tstringproviderAllowed values: provider, getx, riverpod
--description, -dstringA FluttyUI project.Written to generated files
--force, -fboolfalseAllows non-empty target directory

Behavior:

  • Validates project name with ^[a-z][a-z0-9_]*$.
  • Creates: pubspec.yaml, README.md, .gitignore, lib/main.dart, .flutty/template.json.
  • Fails on non-empty target directory unless --force is set.
  • Writes template metadata with codeload source URL into .flutty/template.json.

Template names:

  • provider -> provider-starter
  • getx -> getx-starter
  • riverpod -> riverpod-starter
Example
flutty init my_app --template riverpod --description "My app"

doctor

Check whether the current directory is a valid Flutty project.

flutty doctor

Checks:

  • pubspec.yaml exists (error if missing).
  • pubspec.yaml contains flutter: (warning if missing).
  • lib/main.dart exists (warning if missing).

upgrade

Run schema migrations for the current Flutty project.

flutty upgrade [--dry-run]

Behavior:

  • Requires pubspec.yaml in the current directory.
  • Applies pending migrations and updates .flutty/version.
  • --dry-run lists pending migrations without writing files.