relax_cli library
A CLI tool to generate Flutter projects with clean architecture, multiple state management options, and RelaxORM integration.
Install globally with:
dart pub global activate relax_cli
Usage:
relax create my_app -a bloc
relax generate module user
relax generate model product
relax doctor
Classes
- ArchitectureDetector
- Detects the architecture used by an existing Flutter project by inspecting its pubspec.yaml dependencies.
- BuildCommand
- Parent command that groups Flutter build subcommands.
- CleanCommand
-
Runs
flutter cleanin the current Flutter project. - CreateCommand
- Command to create a new Flutter project with a chosen architecture.
- DoctorCommand
- Checks the development environment for required tools.
- FeatureGenerator
- Generates a new feature module inside an existing Flutter project.
- FeatureResult
- The result of generating a feature: the files created and how (or whether) its route was registered.
- GenerateCommand
-
Parent command for code generation:
relax generate <subcommand>. - ModuleGenerator
- Generates a domain/data module inside an existing Flutter project.
- PageGenerator
- Generates a Page + View pair inside an existing feature folder.
- PageResult
- The result of generating a page: the files created and how (or whether) its route was registered as a child of the feature route.
- ProjectGenerator
- Generates a Flutter project with the chosen architecture.
- PubCommand
- Parent command that groups Flutter pub subcommands.
- QualityCommand
-
relax quality— analyzes a Flutter project's architecture and code quality. - RelaxCommandRunner
- The command runner for the relax CLI.
- RouterGenerator
-
Retroactively scaffolds the navigation layer into an existing project:
creates the router file in the app composition root, gives
HomePageits route identity, and rewiresapp/view/app.dartto drive the router. - RouterScaffoldResult
- Outcome of scaffolding the app router into an existing project.
- SdkCommand
- Parent command for Flutter SDK version management.
Enums
- Architecture
- Supported Flutter architectures for project generation.
- RouteWiring
- How a feature's route was wired into the app router.