fluttercraft CLI (fluttercraft)

Craft Your Flutter Builds with Precision

A cross-platform Dart CLI tool for building Flutter apps. Replaces PowerShell build scripts with a single portable executable.

✨ Key Features

• Interactive Shell: Continuous REPL for rapid development.
• Streamlined Workflow: Build, version, and deploy in one flow.
• Advanced Config: Supports Build Flavors, FVM, Shorebird, and custom Aliases.
• Zero Setup: Works out-of-the-box or with a generated config.

🚀 Quick Start

# 1. Install
dart pub global activate fluttercraft

# 2. Generate config (optional)
flc gen

# 3. Build interactively
flc build

# 4. Or build directly
flc build --platform apk --no-confirm

📦 Installation

1. Stable Channel:

dart pub global activate fluttercraft

or via

dart pub global activate --source git https://github.com/venhdev/fluttercraft-cli.git --git-ref=stable

2. Beta Channel (Git):

dart pub global activate --source git https://github.com/venhdev/fluttercraft-cli.git --git-ref=beta

3. Local (For Dev):

dart pub global activate --source path .

📦 Uninstall

dart pub global deactivate fluttercraft

Alternative: Download the binary from Releases.

🛠 Commands

Command	Description	Example
build	Build Flutter app (APK/AAB/IPA)	flc build --platform apk
clean	Clean project and dist folder	flc clean
gen	Generate configuration file	flc gen
run	Run custom command alias	flc run gen-icon
info	Show loaded context/config	flc info
help	Show available commands	flc help

Tip: run flc --shell to enter interactive mode.

⚙️ Configuration (fluttercraft.yaml)

Run flc gen to create a starter file.

# Simplified Example
build_defaults: &build_defaults
  app_name: myapp
  name: 1.0.0
  platform: aab
  dart_define_from_file: .env

build:
  <<: *build_defaults
  flavor: dev # dev | staging | prod

flavors:
  dev:
    dart_define:
      IS_DEV: true
    dart_define_from_file: .env.dev
  prod:
    flags:
      should_clean: true

environments:
  fvm:
    enabled: true # Auto-detects version from .fvmrc

alias:
  gen-assets:
    cmds:
      - fvm flutter pub run build_runner build

## 🏃 Run Aliases

Run aliases from `fluttercraft.yaml` with parameter substitution.

```yaml
alias:
  commit:
    cmds: ["git commit -m '{0}'"]

Usage: > commit "fix" or flc run commit "fix" Syntax: {0} (pos), {key} (named).

📂 Output

Builds are saved to .fluttercraft/dist/ (or .fluttercraft/dist/<flavor>/). Logs are stored in .fluttercraft/.

License

MIT