Getting Started

CLI

Use the Flutty CLI to scaffold and maintain FluttyUI Flutter projects.

Install from pub.dev:

dart pub global activate flutty

Command format

flutty <command> [arguments]

Global options

Option	Type	Description
`-h`, `--help`	`bool`	Show help output
`-v`, `--version`	`bool`	Show CLI version

Commands

`init`

flutty init <project_name> [options]

Option	Type	Default	Notes
`-t`, `--template`	`String`	`provider`	Allowed: `provider`, `getx`, `riverpod`
`-d`, `--description`	`String`	`A FluttyUI project.`	Written to generated files
`-f`, `--force`	`bool`	`false`	Allows creation in non-empty directory

Creates:

pubspec.yaml
lib/main.dart
.gitignore
README.md
.flutty/template.json
Project name must match ^[a-z][a-z0-9_]*$.
Without --force, command fails if target directory is non-empty.

Template names:

provider -> provider-starter
getx -> getx-starter
riverpod -> riverpod-starter

`doctor`

flutty doctor

Checks:

pubspec.yaml exists.
pubspec.yaml contains flutter: (warn if missing).
lib/main.dart exists (warn if missing).

`upgrade`

flutty upgrade

Requires pubspec.yaml in current directory.
Applies pending schema migrations.

Option:

--dry-run: list pending migrations without writing files.

Installation

Install FluttyUI in your Flutter app, configure dependencies, and verify your first component render.

Theme

Understand the FluttyUI theme model and how global tokens control component styling across your app.

On this page

Command format Global options Commands initdoctorupgrade