11---
22name : magic-framework
3- description : " Magic Framework — Laravel-inspired Flutter framework with IoC Container, Facades, Eloquent ORM, and GoRouter wrapper. ALWAYS activate for: Magic.init, MagicApp, MagicController, MagicView, MagicStatefulView, MagicFormData, MagicRoute, MagicResponse, Eloquent Model, InteractsWithPersistence, HasTimestamps, ServiceProvider, MagicMiddleware, ValidatesRequests, MagicStateMixin, Auth facade, Http facade, Config facade, Cache facade, DB facade, Gate facade, Log facade, Event facade, Lang facade, Schema facade, Vault facade, Storage facade, Pick facade, Crypt facade, MagicCan, MagicCannot, MagicBuilder, MagicForm, WFormInput, QueryBuilder, Blueprint, Migration, Seeder, Factory, Magic.findOrPut, Magic.make, Magic.snackbar, Magic.confirm, Magic.loading, Carbon, trans(), env(), rules(), handleApiError, setErrorsFromResponse, MagicApplication, RouteServiceProvider, Kernel. Use for ANY Flutter project built on the Magic framework."
3+ description: "Magic Framework — Laravel-inspired Flutter framework with IoC Container, Facades, Eloquent ORM, and GoRouter wrapper. ALWAYS activate for: Magic.init, MagicApp, MagicController, MagicView, MagicStatefulView, MagicFormData, MagicRoute, MagicResponse, Eloquent Model, InteractsWithPersistence, HasTimestamps, ServiceProvider, MagicMiddleware, ValidatesRequests, MagicStateMixin, Auth facade, Http facade, Config facade, Cache facade, DB facade, Gate facade, Log facade, Event facade, Lang facade, Schema facade, Vault facade, Storage facade, Pick facade, Crypt facade, Launch facade, LaunchServiceProvider, MagicCan, MagicCannot, MagicBuilder, MagicForm, WFormInput, QueryBuilder, Blueprint, Migration, Seeder, Factory, Magic.findOrPut, Magic.make, Magic.snackbar, Magic.confirm, Magic.loading, Carbon, trans(), env(), rules(), handleApiError, setErrorsFromResponse, MagicApplication, RouteServiceProvider, Kernel, magic install, make:model, make:controller, make:view, make:migration, make:enum, make:event, make:listener, make:middleware, make:factory, make:seeder, make:provider, make:policy, make:request, make:lang, key:generate, magic CLI. Use for ANY Flutter project built on the Magic framework."
44---
55
66# Magic Framework
@@ -10,7 +10,7 @@ Laravel-inspired Flutter framework. IoC Container + Facades + Eloquent ORM + GoR
1010## Core Laws
1111
12121 . ** await Magic.init()** : Must be awaited in ` main() ` before ANY facade call. Never ` .then() ` .
13- 2 . ** Facade-first** : Use ` Auth ` , ` Http ` , ` Config ` , ` Cache ` , ` DB ` , ` Log ` , ` Event ` , ` Lang ` , ` Route ` , ` Gate ` , ` Schema ` , ` Vault ` , ` Storage ` , ` Pick ` , ` Crypt ` — never resolve manually unless extending.
13+ 2 . ** Facade-first** : Use ` Auth ` , ` Http ` , ` Config ` , ` Cache ` , ` DB ` , ` Log ` , ` Event ` , ` Lang ` , ` Route ` , ` Gate ` , ` Schema ` , ` Vault ` , ` Storage ` , ` Pick ` , ` Crypt ` , ` Launch ` — never resolve manually unless extending.
14143 . ** Singleton controllers** : ` static X get instance => Magic.findOrPut(X.new); ` — the canonical pattern.
15154 . ** Typed getters** : Models use ` get<T>('key') ` — never ` getAttribute() ` .
16165 . ** fillable whitelist** : Models declare ` fillable ` — never use ` guarded = [] ` .
@@ -227,6 +227,7 @@ await Auth.restore() // Restore from Vault
227227| Forgetting ` form.dispose() ` | Always in ` onClose() ` | Memory leak |
228228| Missing ` setUserFactory ` | Call in ` boot() ` | Auth facade broken |
229229| ` Event.dispatch(event) ` | ` EventDispatcher.instance.register(type, [...]) ` | Facade only has dispatch — register listeners via EventDispatcher |
230+ | Using ` Launch ` without ` LaunchServiceProvider ` | Add ` (app) => LaunchServiceProvider(app) ` to ` app.providers ` | Facade unresolvable |
230231
231232## Test Setup (Mandatory)
232233
@@ -239,17 +240,36 @@ setUp(() {
239240
240241Mock by extending contracts. Inject via ` Magic.put<T>(mockController) ` . Never use code generation for mocks.
241242
243+
244+ ## CLI Quick Reference
245+
246+ Magic CLI provides Artisan-inspired code generation. Install with ` dart pub global activate fluttersdk_magic_cli ` .
247+
248+ ``` bash
249+ magic install # Initialize project
250+ magic make:model Monitor -mcfsp # Model + migration + controller + factory + seeder + policy
251+ magic make:controller Monitor -r # Resource controller with CRUD
252+ magic make:view Login --stateful # Stateful view with lifecycle
253+ magic make:migration create_monitors # Database migration
254+ magic make:enum MonitorStatus # String-backed enum
255+ magic make:provider Payment # Service provider
256+ magic key:generate # Generate APP_KEY
257+ ```
258+
259+ All generators support ` --force ` (overwrite) and nested paths (` Admin/Dashboard ` ). Auto-suffixes are appended when missing.
260+
242261## Reference Index
243262
244263| File | Content | Load When |
245264| ------| ---------| -----------|
246265| ` references/bootstrap-lifecycle.md ` | Magic.init steps, IoC API, ServiceProvider, Env/Config, Kernel | Setting up app bootstrap or providers |
247- | ` references/facades-api.md ` | All 15 facades with method signatures and return types | Looking up any facade API |
266+ | ` references/facades-api.md ` | All 16 facades (incl. Launch) with method signatures and return types | Looking up any facade API |
248267| ` references/eloquent-orm.md ` | Model definition, attributes, casts, relations, QueryBuilder, migrations | Working with models or database |
249268| ` references/controllers-views.md ` | MagicController, MagicStateMixin, MagicView, MagicBuilder, auth widgets | Building controllers or views |
250269| ` references/forms-validation.md ` | MagicFormData, MagicForm, rules(), Validator, built-in rules, i18n | Building forms or validation |
251270| ` references/routing-navigation.md ` | Route registration, groups, transitions, middleware, navigation API | Setting up routes or navigation |
252271| ` references/http-network.md ` | NetworkManager, MagicResponse, interceptors, config | Making HTTP requests or configuring network |
253272| ` references/auth-system.md ` | AuthManager, guards, token refresh, policies, Gate | Implementing authentication or authorization |
254- | ` references/secondary-systems.md ` | Cache, Events, Logging, Localization, Storage, Encryption, Vault, Carbon, Policies | Using any secondary framework system |
273+ | ` references/secondary-systems.md ` | Cache, Events, Logging, Localization, Storage, Encryption, Vault, Carbon, Launch, Policies | Using any secondary framework system |
255274| ` references/testing-patterns.md ` | Test setup, mocking, controller/model/middleware testing | Writing tests for Magic framework code |
275+ | ` references/cli-commands.md ` | Magic CLI: install, make:* generators, inspection, boost/MCP commands | Scaffolding code or setting up a project with the CLI |
0 commit comments