Magic CLI ⚡

The Artisan-like CLI for Magic. Scaffold controllers, models, views, migrations, and more with a single command.

---

🚀 Installation

dart pub global activate fluttersdk_magic_cli

Ensure ~/.pub-cache/bin is in your PATH.

---

📦 Quick Start

# Navigate to your Flutter project
cd my_app

# Initialize Magic with all features
magic init

# Or exclude specific features
magic init --without-database --without-events

---

🛠️ Available Commands

Project Setup

Command	Description
magic init	Initialize Magic in an existing Flutter project
magic key:generate	Generate a new application encryption key

Make Commands

Command	Description
magic make:model User	Create an Eloquent model
magic make:controller User	Create a controller
magic make:view Login	Create a view class
magic make:policy Post	Create an authorization policy
magic make:migration create_users_table	Create a database migration
magic make:seeder UserSeeder	Create a database seeder
magic make:factory UserFactory	Create a model factory
magic make:lang tr	Create a language file

---

📖 Command Details

magic init

Initializes Magic in your Flutter project with the recommended directory structure and configuration.

magic init

Options:

Option	Description
--without-database	Skip database support
--without-cache	Skip caching
--without-auth	Skip authentication
--without-events	Skip event system
--without-localization	Skip localization/i18n

---

magic make:model

Creates an Eloquent-style model with optional related files.

magic make:model User
magic make:model Post --migration --controller --factory
magic make:model Comment -mcf  # Shorthand

Options:

Option	Short	Description
--migration	-m	Create a migration file
--controller	-c	Create a controller
--factory	-f	Create a model factory
--seeder	-s	Create a seeder
--all	-a	Create all related files

Output:

lib/app/models/user.dart

---

magic make:controller

Creates a controller class.

magic make:controller UserController
magic make:controller User  # Auto-appends 'Controller'
magic make:controller Admin/Dashboard  # Nested path

Options:

Option	Description
--resource, -r	Create a resource controller with CRUD methods
--model, -m	Specify the model for resource controller

Output:

lib/app/controllers/user_controller.dart

---

magic make:view

Creates a view class with MagicStateMixin.

magic make:view LoginView
magic make:view Login  # Auto-appends 'View'
magic make:view Auth/Register  # Nested path

Output:

lib/resources/views/login_view.dart

---

magic make:migration

Creates a database migration file.

magic make:migration create_users_table
magic make:migration add_email_to_users_table

Options:

Option	Description
--create, -c	The table to be created
--table, -t	The table to migrate

Output:

lib/database/migrations/2024_01_15_120000_create_users_table.dart

---

magic make:policy

Creates an authorization policy.

magic make:policy PostPolicy
magic make:policy Post  # Auto-appends 'Policy'
magic make:policy Comment --model=Comment

Options:

Option	Description
--model, -m	The model that the policy applies to

Output:

lib/app/policies/post_policy.dart

---

magic make:seeder

Creates a database seeder.

magic make:seeder UserSeeder

Output:

lib/database/seeders/user_seeder.dart

---

magic make:factory

Creates a model factory.

magic make:factory UserFactory
magic make:factory User  # Auto-appends 'Factory'

Output:

lib/database/factories/user_factory.dart

---

magic make:lang

Creates a language JSON file.

magic make:lang tr
magic make:lang es

Output:

assets/lang/tr.json

---

magic key:generate

Generates a random encryption key for your application.

magic key:generate

Updates your .env file with:

APP_KEY=base64:randomGeneratedKey...

---

📁 Generated Structure

After running magic init, your project will have:

lib/
├── config/
│   ├── app.dart
│   ├── auth.dart
│   └── database.dart
├── app/
│   ├── controllers/
│   ├── models/
│   └── policies/
├── database/
│   ├── migrations/
│   ├── seeders/
│   └── factories/
├── resources/
│   └── views/
├── routes/
│   └── web.dart
└── main.dart

---

🤝 Contributing

Contributions are welcome! Please read our contributing guidelines.

---

📄 License

Magic CLI is open-sourced software licensed under the MIT license.