orbital_rapid_cli 1.0.2+1
orbital_rapid_cli: ^1.0.2+1 copied to clipboard
Generate Flutter splash/onboarding/auth flows with Riverpod, BLoC, or GetX
π Orbital Rapid CLI #
Generate production-ready Flutter auth & onboarding flows in seconds.
Supports Riverpod Β· BLoC Β· GetX Β· Firebase Β· REST API Β· Supabase
β¨ What Is This? #
Orbital Rapid CLI is a command-line tool that scaffolds complete, production-ready Flutter application flows β splash, onboarding, login, registration, forgot password, logout, and account deletion β with your chosen state management and backend, in a single command.
No more copy-pasting boilerplate. No more spending the first week of every project writing the same screens.
orbitalRapid init
? Project name: awesome_app
? Package name: com.mycompany.awesome_app
? State management: Riverpod
? Backend: Firebase
? Screens: Splash, Onboarding, Login, Register, Forgot Password, Account Deletion
? Dark mode support: Yes
? Localization ready: Yes
β Έ Generating project structure... β
β Έ Generating core utils... β
β Έ Generating theme system... β
β Έ Generating splash screen... β
β Έ Generating onboarding flow... β
β Έ Generating auth screens... β
β Έ Generating account screens... β
β Έ Injecting dependencies... β
β Έ Writing pubspec.yaml... β
β
47 files generated in 1.8 seconds
π Project ready at: ./awesome_app/
π Next: cd awesome_app && flutter pub get && flutter run
π¦ Installation #
Requires Dart SDK >=3.0.0.
dart pub global activate orbital_rapid_cli
Ensure your Dart pub global bin is in your PATH. Depending on your OS:
Linux / macOS #
# Add to ~/.bashrc or ~/.zshrc
export PATH="$PATH":"$HOME/.pub-cache/bin"
Windows #
PowerShell:
# Add to current session
$env:Path += ";$env:LOCALAPPDATA\Pub\Cache\bin"
# Add permanently
[System.Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:LOCALAPPDATA\Pub\Cache\bin", "User")
Command Prompt (CMD):
setx PATH "%PATH%;%LOCALAPPDATA%\Pub\Cache\bin"
Verify installation:
orbitalRapid --version
# Orbital Rapid CLI v1.0.0
π― Quick Start #
Option 1 β Interactive (Recommended) #
# Navigate to where you want your project created
cd ~/projects
# Run interactive setup
orbitalRapid init
Follow the prompts. Takes about 30 seconds.
Option 2 β Inline Flags (No Prompts) #
orbitalRapid init \
--name=awesome_app \
--package=com.mycompany.awesome_app \
--state=riverpod \
--backend=firebase \
--screens=all \
--dark-mode \
--l10n
Option 3 β Config File #
# Use a saved config (great for teams)
orbitalRapid init --config=orbitalRapid.yaml
π₯οΈ Commands #
orbitalRapid init #
Scaffold a complete new project with selected flows.
orbitalRapid init [options]
Options:
--name Project name (snake_case)
--package Package identifier (com.company.app)
--state State management: riverpod | bloc | getx
--backend Backend: firebase | rest | supabase | none
--screens Comma-separated or 'all'
--dark-mode Include dark mode support
--l10n Include localization scaffolding
--dry-run Preview files without writing
--config Path to orbitalRapid.yaml config file
--output Output directory (default: ./<project-name>)
orbitalRapid add #
Add individual screens to an existing Flutter project.
orbitalRapid add <screen> [options]
# Examples
orbitalRapid add splash
orbitalRapid add login --state=bloc
orbitalRapid add onboarding --pages=4
orbitalRapid add account-deletion --backend=firebase
Screens: splash | onboarding | login | register |
forgot-password | logout | account-deletion
orbitalRapid upgrade #
Upgrade CLI to the latest version.
orbitalRapid upgrade
orbitalRapid --version #
Print current CLI version.
ποΈ Generated Project Structure #
awesome_app/
β
βββ lib/
β βββ core/
β β βββ utils/ β βοΈ CUSTOMIZE HERE
β β β βββ app_colors.dart
β β β βββ app_gradients.dart
β β β βββ app_text_styles.dart
β β β βββ app_fonts.dart
β β β βββ app_dimensions.dart
β β β βββ app_strings.dart
β β β
β β βββ theme/
β β β βββ app_theme.dart
β β β βββ app_dark_theme.dart
β β β
β β βββ constants/
β β β βββ app_assets.dart
β β β βββ app_routes.dart
β β β βββ app_enums.dart
β β β
β β βββ network/ β (REST backend only)
β β β βββ api_client.dart
β β β βββ api_endpoints.dart
β β β βββ interceptors/
β β β βββ auth_interceptor.dart
β β β βββ logging_interceptor.dart
β β β
β β βββ services/
β β βββ storage_service.dart
β β βββ navigation_service.dart
β β βββ auth_service.dart
β β
β βββ features/
β β βββ splash/
β β βββ onboarding/
β β βββ auth/
β β β βββ login/
β β β βββ register/
β β β βββ forgot_password/
β β βββ account/
β β
β βββ main.dart
β
βββ assets/
β βββ images/
β βββ icons/
β βββ fonts/
β βββ lottie/
β
βββ test/
βββ pubspec.yaml
βββ orbitalRapid.yaml
π¨ Customization (After Generation) #
Your only job after running the CLI:
| File | What to change |
|---|---|
app_colors.dart |
Your brand hex values |
app_fonts.dart |
Your font family name |
app_text_styles.dart |
Font sizes and weights |
app_dimensions.dart |
Spacing and radius values |
app_strings.dart |
All text content and copy |
app_gradients.dart |
Gradient colors |
app_assets.dart |
Image and icon paths |
Everything else β every screen, every widget, every state class β reads from these files automatically.
βοΈ State Management Support #
| Feature | Riverpod | BLoC | GetX |
|---|---|---|---|
| State classes | β | β | β |
| Events | β | β | β |
| Notifiers / Controllers | β | β | β |
| Dependency injection | β | β | β |
| Test generation | β | β | β |
π Backend Support #
| Feature | Firebase | REST API | Supabase | None |
|---|---|---|---|---|
| Login | β | β | β | Stub |
| Register | β | β | β | Stub |
| Logout | β | β | β | Stub |
| Forgot password | β | β | β | Stub |
| Account deletion | β | β | β | Stub |
| Token refresh | β | β | β | β |
| Social auth | β | β | β | β |
π€ Contributing #
We welcome contributions! See CONTRIBUTING.md for guidelines.
Ways to contribute:
- π Report bugs via GitHub Issues
- π‘ Request features via Discussions
- π§© Add new screen templates
- π Add new backend adapters
- π Add localization support
- β Write tests
π License #
MIT Β© Bony Yamin
Made with β€οΈ for the Flutter community
β Star us on GitHub