Installation

• Requirements
• Installation
• Basic Setup
• Verify Installation

Getting started with fluttersdk_artisan requires a few steps to wire the CLI binary and codegen scaffolding into your project.

Requirements

Before adding fluttersdk_artisan to your project, ensure your environment meets these minimum version requirements. We recommend staying on the latest stable Dart SDK for the best experience.

fluttersdk_artisan is a pure Dart package. Flutter is optional: it is only required when you intend to drive a running Flutter app (hot reload, Dusk gestures, Telescope inspection). Projects that only need scaffolding, code generation, or the MCP server can run on any Dart 3.4+ environment.

Installation

Add fluttersdk_artisan to your project using the Dart CLI:

dart pub add fluttersdk_artisan

Alternatively, add it manually to your pubspec.yaml:

dependencies:
  fluttersdk_artisan: ^0.0.1

Then fetch dependencies:

dart pub get

Basic Setup

After installing the package, run the scaffold command to create the canonical consumer wrapper in your project:

dart run fluttersdk_artisan consumer:scaffold

This command writes three files into your project:

The command is idempotent: re-running it skips files that already exist. Pass --force to overwrite:

dart run fluttersdk_artisan consumer:scaffold --force

Dependency injection into pubspec.yaml

consumer:scaffold also ensures fluttersdk_artisan is listed as a direct dependency in your pubspec.yaml. The generated barrel files at lib/app/_plugins.g.dart and lib/app/commands/_index.g.dart import from package:fluttersdk_artisan/artisan.dart, so the analyzer requires a direct dep to pass depend_on_referenced_packages.

The injection is automatic and follows two modes:

• Monorepo / path-dep workflow: when your project already resolves fluttersdk_artisan via a local path (detected from .dart_tool/package_config.json), the scaffold injects a path: reference pointing to the same checkout. This avoids a pub.dev fetch against a version that may not yet be published.
• pub.dev workflow: when no local resolution is found, the scaffold injects the any constraint and lets pub resolve the version transitively. Replace any with a pinned range (e.g. ^0.0.1) before committing.

Verify Installation

Run the built-in list command to confirm the scaffold is wired correctly:

dart run artisan list

The output lists all registered commands grouped by namespace. A fresh scaffold with no additional plugins shows 21 built-in commands organized across these namespaces:

If the list prints without errors, the installation is complete.