devforge #

Dart Flutter License

🚀 A powerful CLI for generating Flutter/Dart boilerplate code

Stop writing the same utility files over and over—let devforge handle the heavy lifting!

📚 Documentation #

Document	Description
doc/COMMANDS.md	Full command reference with examples
doc/CONFIGURATION.md	User and project configuration (`devforge.yaml`)
doc/ARCHITECTURE.md	Project structure and execution flow
doc/CONTRIBUTING.md	How to contribute and add generators/commands
doc/README.md	Documentation index

🎯 Project Goals #

Goal	Description
⚡ Simple commands	Provide straightforward commands for common Flutter code generation workflows
🔄 Reduce repetition	Cut down repetitive setup and manual file creation
📋 Dual modes	Support both direct commands and interactive menu-driven generation

✨ Features #

devforge offers both direct command execution and an interactive mode to quickly scaffold necessary services and utilities:

Icon	Feature	Description
🌐	ApiClient Service	Creates `api_client.dart` with Dio-based API setup + `logger_interceptor.dart`
📦	Assets Utility	Creates `assets_utils.dart` with static paths for all resources in `assets/`
🔔	FCM Service	Generates `fcm_service.dart` for Firebase Cloud Messaging setup
🔑	Refresh Token Service	Scaffolds `refresh_token.dart` for token refresh logic
💾	Local Storage Service	Creates `SharedPreferencesService` or `GetStorageService`
🗄️	Sqflite Service	Creates `sqflite_service.dart` for local SQLite storage
📄	Pagination Utilities	Creates controller + `paging_list_view.dart` / `paging_custom_scroll_view.dart`
🧩	BLoC Boilerplate	Creates bloc folder with `bloc.dart`, `state.dart`, `event.dart`
🎮	GetX Boilerplate	Creates GetX folder with `controller.dart`, `bindings.dart`, `screen.dart`
🖼️	App Icon Generator	Generates app icons for all supported platforms
🌍	Localization	Extract strings, generate locale keys and translation files
🩺	Flutter doctor	Run environment and dependency checks
🧹	Cache cleaning	Flutter clean and optional pub cache clean
📦	Flavor builds	Build APK, AppBundle, iOS, or IPA with optional flavor
🎛️	Interactive Mode	Use `devforge run` for a friendly menu-driven experience

📋 Requirements #

Requirement	Details
🎯 Dart SDK	`>=3.0.0 <4.0.0`
📦 Flutter/Dart project	Generated files are placed under `lib/`
🔗 PATH	Ensure `~/.pub-cache/bin` (or equivalent) is in your `PATH`

🚀 Installation #

1️⃣ Activate the package #

Activate devforge globally using the Dart package manager:

dart pub global activate devforge

2️⃣ Verify installation #

devforge --help
# or
devforge -h

3️⃣ Check version #

devforge --version
# or
devforge -v

👨‍💻 Usage #

There are two primary ways to use DevForge: interactive mode and direct commands.

1️⃣ Interactive mode (`devforge run`) #

For generating multiple files at once or for a guided experience, use the run command:

devforge run

This launches an interactive multi-select menu and lets you choose which services you want to generate:

? Select what you have to generate:

[ ] Generate ApiClient
[ ] Generate AssetsUtils
[ ] Generate FcmService
[ ] Generate RefreshToken service
[ ] Generate Local Storage Service
[ ] Generate SqfliteService
[ ] Generate Pagination Service
[ ] Generate BLoC folder
[ ] Generate Getx folder
[ ] Generate App icons
[ ] Generate Localization (locale keys + translation files)
[ ] Run Flutter doctor
[ ] Clean (Flutter + optional pub cache)
[ ] Build (APK / AppBundle / iOS / IPA with optional flavor)

2️⃣ Direct commands #

Use these commands for quick, single-purpose generation:

Command	Description	Output file(s) / effect
`devforge generate_config`	Generates a `devforge.yaml` configuration file in the current project.	`devforge.yaml` in the project root
`devforge userInfo`	Opens an interactive prompt to update your stored name (used in generated file comments).	Updates user name stored in DevForge config
`devforge show_user_name`	Prints your currently saved user name.	Outputs the saved name in the terminal
`devforge api_client`	Generates a boilerplate service for handling API calls.	`lib/api_client.dart`, `lib/logger_interceptor.dart`
`devforge assets`	Scans the `assets/` folder and generates the assets utility file.	`lib/assets_utils.dart`
`devforge fcm`	Generates a boilerplate service for handling FCM.	`lib/fcm_service.dart`
`devforge refresh`	Generates the service for managing refresh token logic.	`lib/refresh_token.dart`
`devforge local_storage`	Interactively chooses and generates either shared_preferences or get_storage service.	`lib/shared_preferences_service.dart` or `lib/get_storage_service.dart`
`devforge sqflite`	Generates a `sqflite` singleton service.	`lib/sqflite_service.dart`
`devforge pagination`	Generates a controller and reusable widgets for paginated lists.	`lib/pagination_controller.dart`, `lib/paging_list_view.dart`, `lib/paging_custom_scroll_view.dart`
`devforge bloc`	Generates a BLoC directory with `bloc.dart`, `state.dart`, and `event.dart`.	BLoC folder (path chosen interactively)
`devforge getx`	Generates a GetX directory with controllers, bindings, and views.	GetX folder (path chosen interactively)
`devforge app-icon`	Generates app icons of different sizes in platform-specific folders.	Platform-specific icon assets
`devforge localize`	Extracts strings, generates locale keys and translation files.	`lib/locale_keys.dart`, `lib/en.dart`, etc., `lib/localization_service.dart`
`devforge doctor`	Runs Flutter doctor to check environment and dependencies.	Terminal output from `flutter doctor -v`
`devforge clean`	Cleans Flutter build/cache; optionally cleans Dart pub cache.	Interactive choice, then runs `flutter clean` (and optionally `dart pub cache clean`)
`devforge build`	Builds APK, AppBundle, iOS, or IPA with optional flavor.	Interactive menu for target and flavor, then runs `flutter build`

If you pass --help with no command, you’ll see the full list of supported commands.

🛠️ Configuration #

DevForge stores your author name and can generate a project-level configuration file.

Action	Command
👤 Update name	`devforge userInfo`
👁️ Show saved name	`devforge show_user_name`
⚙️ Generate config	`devforge generate_config`

ℹ️ On first run, DevForge prompts for your name (used in generated file comments).
⚙️ generate_config creates devforge.yaml in the current directory for customizing generators.

📂 Output structure #

Generated files are placed in the lib/ directory or in a subfolder you specify:

📁 Service files (API client, FCM, storage, sqflite, pagination) → created under lib/ by default
📁 Folder-based generators (BLoC / GetX) → you choose the target path interactively
📁 App icons → generated in platform-specific asset folders (Android/iOS)
🔍 Flutter project detection — Generator commands check for a Flutter project (e.g. pubspec.yaml with Flutter SDK) before running.

📁 Project Structure #

devforge/
├── bin/
│   └── devforge.dart              # CLI entrypoint
├── lib/
│   ├── generators/                # Code generators
│   │   ├── api_client_generator.dart
│   │   ├── assets_generator.dart
│   │   ├── bloc_generator.dart
│   │   ├── fcm_generator.dart
│   │   ├── getx_generator.dart
│   │   ├── app_storage_generator.dart
│   │   ├── pagination_generator.dart
│   │   ├── app_icon_generator.dart
│   │   ├── yaml_generator.dart
│   │   └── localization/
│   ├── commands/                  # Process-based commands
│   │   ├── doctor_command.dart
│   │   ├── clean_command.dart
│   │   └── build_command.dart
│   ├── templates/                 # Dart code templates
│   │   ├── api_client_template.dart
│   │   ├── bloc_template.dart
│   │   └── ...
│   └── utils/                     # Shared utilities
│       ├── user_config.dart
│       ├── devforge_config.dart
│       ├── colors.dart
│       ├── console_log.dart
│       ├── version_checker.dart
│       ├── process_runner.dart
│       ├── flutter_project_detector.dart
│       └── spinner.dart
└── test/
    └── devforge_test.dart

🏗️ Architecture #

Rule	Description
1️⃣	Each generator lives in its own file under `lib/generators`
2️⃣	Generators expose a single async function (e.g. `generateApiClientService()`)
3️⃣	Templates use string interpolation in `lib/templates`
4️⃣	CLI arguments parsed with the `args` package
5️⃣	Terminal output goes through `console_log.dart`
6️⃣	Colors defined in `colors.dart`
7️⃣	Shell execution (flutter/dart) goes through `process_runner.dart`
8️⃣	Flutter project detection via `flutter_project_detector.dart` before generators
9️⃣	Main entrypoint is `bin/devforge.dart`

📐 Coding Guidelines #

✅ Follow Dart best practices
✅ Keep functions small and modular
✅ Use async/await for file generation
✅ Print helpful CLI messages
✅ Fail gracefully with meaningful errors

🔮 Future Features #

Status	Feature
🔜	Additional flavor presets (e.g. dev/staging/prod templates)
🔜	More progress spinners in heavy generators
🔜	Optional config file for default paths

🧑‍💻 Development #

If you want to contribute to DevForge:

Step	Command
1️⃣ Clone	`git clone https://github.com/prathamesh-mali/devforge.git && cd devforge`
2️⃣ Dependencies	`dart pub get`
3️⃣ Run locally	`dart run bin/devforge.dart --help`
4️⃣ Run tests	`dart test`

📝 License #

MIT License. See LICENSE for details.

devforge 1.4.0
devforge: ^1.4.0 copied to clipboard

Metadata

devforge #

📚 Documentation #

📑 Table of contents #

🎯 Project Goals #

✨ Features #

📋 Requirements #

🚀 Installation #

1️⃣ Activate the package #

2️⃣ Verify installation #

3️⃣ Check version #

👨‍💻 Usage #

1️⃣ Interactive mode (`devforge run`) #

2️⃣ Direct commands #

🛠️ Configuration #

📂 Output structure #

📁 Project Structure #

🏗️ Architecture #

📐 Coding Guidelines #

🔮 Future Features #

🧑‍💻 Development #

📝 License #

← Metadata

Publisher

Weekly Downloads

Metadata

License

Dependencies

More

devforge 1.4.0 devforge: ^1.4.0 copied to clipboard

Metadata

devforge #

📚 Documentation #

📑 Table of contents #

🎯 Project Goals #

✨ Features #

📋 Requirements #

🚀 Installation #

1️⃣ Activate the package #

2️⃣ Verify installation #

3️⃣ Check version #

👨‍💻 Usage #

1️⃣ Interactive mode (devforge run) #

2️⃣ Direct commands #

🛠️ Configuration #

📂 Output structure #

📁 Project Structure #

🏗️ Architecture #

📐 Coding Guidelines #

🔮 Future Features #

🧑‍💻 Development #

📝 License #

← Metadata

Publisher

Weekly Downloads

Metadata

License

Dependencies

More

devforge 1.4.0
devforge: ^1.4.0 copied to clipboard

1️⃣ Interactive mode (`devforge run`) #