flutter_starter_template_cli 1.0.1

CLI to scaffold new Flutter projects from flutter-starter-template.

flutter_starter_template_cli

A CLI tool to scaffold new Flutter projects from flutter-starter-template — batteries-included with Firebase, BLoC, auto_route, ObjectBox, and more.

Installation

dart pub global activate flutter_starter_template_cli

Make sure ~/.pub-cache/bin is on your PATH:

export PATH="$PATH:$HOME/.pub-cache/bin"

Usage

fst create

The CLI will prompt you for:

Prompt	Example
App display name	My Awesome App
Dart package name	my_awesome_app (auto-derived)
Bundle / App ID	com.acme.myapp
Organisation / author	Acme Inc

After confirmation it will:

1. Clone the template (with submodules) into a new directory
2. Rename every identifier across pubspec.yaml, Gradle, Xcode, and lib/
3. Move MainActivity.kt to the correct package path
4. Run tool/setup.sh — installs dependencies and runs code generation

Options

fst create [options]

-n, --name            App display name (skips the prompt)
    --package-name    Dart package name, snake_case (default: derived from --name)
    --bundle-id       Bundle / App ID, reverse-DNS (skips the prompt)
    --org             Organisation / author (skips the prompt)
-o, --output-dir       Directory to create the project in (default: <package-name>)
    --[no-]firebase    Wire Firebase (default on); --no-firebase scaffolds without it
    --exclude-feature  Demo feature(s) to leave out (repeatable): bookmarks,
                       collections, notifications
    --api-url          Base URL for the staging & prod env files (dev keeps localhost)
    --icon             Path to a square PNG used to generate the launcher icon
-y, --yes              Run non-interactively: no prompts, no confirmation
    --no-setup         Skip running tool/setup.sh after scaffolding

Each input can be supplied as a flag instead of answering its prompt. When a flag is given its value is validated and used as-is — an invalid value exits with an error rather than falling back to a prompt.

Firebase

By default the project keeps Firebase wired (you then point it at your own project with flutterfire configure). Pass --no-firebase (or answer the prompt) to scaffold without Firebase: the app builds and runs with no Firebase project at all. --no-firebase skips the platform initialisation, swaps the analytics and crash-reporting bindings to no-ops, removes the Firebase Android Gradle plugins, and deletes the template's native Firebase credentials.

It's reversible: set kFirebaseEnabled back to true in lib/app/firebase.dart, restore the tracking bindings at the // fst:analytics-impl and // fst:crash-impl markers, and run flutterfire configure. Analytics and crash reporting are independent ports — keep one on Firebase and the other no-op by editing just that binding.

Excluding demo features

The template ships three demo content features you can leave out: bookmarks, collections, notifications (the auth, home, profile, and splash core features are always kept). Pass --exclude-feature (repeatable) or deselect them in the interactive multi-select; the CLI strips each feature's // fst:feature:<name> regions from the app wiring and deletes its package. Because bookmarks depends on collections, excluding collections also excludes bookmarks.

API base URL & launcher icon

• --api-url https://api.acme.com rewrites API_BASE_URL in env/staging.json and env/prod.json (dev keeps http://localhost:8080). Blank/omitted keeps the template values.
• --icon path/to/icon.png copies a square PNG into tool/launcher_icons/ and runs flutter_launcher_icons after setup. Omitted keeps the template icon.

Non-interactive (CI / scripts)

Pass --yes to skip every prompt and the confirmation. It requires --name, --bundle-id, and --org; --package-name defaults to the snake_case form of --name. A missing required flag exits non-zero with a clear message.

fst create \
  --yes \
  --name "Acme App" \
  --bundle-id com.acme.app \
  --org "Acme Inc" \
  --output-dir ./acme_app

Example

$ fst create

  Flutter Starter Template — project scaffold

  App display name: Acme App
  Dart package name (snake_case): acme_app
  Bundle / App ID (reverse-DNS): com.acme.app
  Organisation / author: Acme Inc

  Project summary
  Display name   Acme App
  Package name   acme_app
  Bundle ID      com.acme.app
  Organisation   Acme Inc
  Output dir     /Users/you/acme_app

  Create project? (Y/n) y

  ✓ Template cloned
  ✓ Identifiers renamed
  ✓ Dependencies installed & code generated

  Project created at /Users/you/acme_app

  ⚠ Firebase is still wired to the template. lib/firebase_options.dart points
    at the template Firebase project, so the app will use it until you
    reconfigure it for your own project.

  Next steps:
    cd acme_app

    # Point Firebase at your own project:
    dart pub global activate flutterfire_cli  # if not installed
    flutterfire configure

    # Then run the app:
    fvm flutter run

Firebase is not yours yet. fst create only renames identifiers — it does not touch your Firebase credentials. The generated lib/firebase_options.dart (and any native config) still targets the template's Firebase project. Run flutterfire configure to point the app at your own project before shipping.

Requirements

• Dart SDK >=3.4.0
• git on your PATH (for cloning the template)
• FVM (recommended) or a Flutter SDK on your PATH

What the template includes

See the flutter-starter-template README for the full feature list.

Contributing

The source lives at published/cli/ inside the main template repository, and is mirrored here as a standalone package for pub.dev.

1. Fork flutter-starter-template-cli
2. Make changes and run dart test
3. Open a pull request

License

MIT