Flutterchi 🚀 #

A powerful CLI tool to automate Flutter builds. Create APK, App Bundle, and Windows EXE with simple commands.

✨ Features #

• 🚀 Quick Build Commands - Build APK, AAB, and EXE with one command
• 🔍 Smart Flutter Detection - Automatically finds Flutter installation
• 📁 Auto-Save to Desktop - Saves builds to Desktop/FlutterBuilds
• 📊 Progress Tracking - See build progress in real-time
• 🎯 Version Management - Automatically names files with version
• 💻 Cross-Platform - Works on Windows, macOS, and Linux
• 🌐 Multi-Language Support - English and Uzbek

📦 Installation #

Global Installation (Recommended) #

dart pub global activate flutterchi

From Source #

git clone https://github.com/flutterchi/flutterchi.git
cd flutterchi
dart pub global activate --source path .

🚀 Quick Start #

1. Check Installation #

First, verify that Flutter and Flutterchi are properly installed:

flutterchi check

2. Navigate to Your Project #

cd your_flutter_project

3. Build Your App #

# Build APK
flutterchi apk

# Build App Bundle
flutterchi bundle

# Build Windows EXE (Windows only)
flutterchi exe

# Build all formats
flutterchi all

📚 Commands #

📁 Output Location #

All builds are automatically saved to:

Desktop/FlutterBuilds/
├── myapp_v1.0.0.apk
├── myapp_v1.0.0.aab
└── myapp_v1.0.0_windows/
    └── myapp.exe

File naming format: {app_name}_v{version}.{extension}

🔧 Requirements #

• Dart SDK: >=3.0.0 <4.0.0
• Flutter SDK: Any recent version
• Operating Systems: Windows, macOS, Linux
• Note: Windows EXE can only be built on Windows

⚙️ Configuration #

Flutterchi automatically detects your Flutter installation from:

• System PATH
• Common installation directories:
  • Windows: C:\src\flutter, C:\flutter, %USERPROFILE%\flutter
  • macOS/Linux: ~/flutter, /usr/local/flutter, /opt/flutter

🐛 Troubleshooting #

Flutter not found #

If you see "Flutter not found" error:

1. Check Flutter installation:

   flutter --version
   

2. Add Flutter to PATH:

   • Windows: Add C:\path\to\flutter\bin to System Environment Variables
   • macOS/Linux: Add to ~/.bashrc or ~/.zshrc:

     export PATH="$PATH:/path/to/flutter/bin"
     

3. Restart terminal and run:

   flutterchi check
   

Build fails #

• Make sure you're in a Flutter project directory
• Run flutter doctor to check for issues
• Ensure all dependencies are installed: flutter pub get

Permission denied (macOS/Linux) #

chmod +x $(which flutterchi)

📝 Examples #

Build APK for release #

cd my_awesome_app
flutterchi apk

Output:

🚀 Flutterchi - Flutter Build Automation Tool
============================================================

📱 Building APK...

⏳ Cleaning...
✅ Cleaning completed

⏳ Getting packages...
✅ Getting packages completed

⏳ Building APK (this may take a while)...
✅ Building APK completed

📁 Saved: /Users/user/Desktop/FlutterBuilds/my_awesome_app_v1.0.0.apk
📊 Size: 18.5 MB

🎉 APK successfully built!
📍 Location: /Users/user/Desktop/FlutterBuilds
📦 File: my_awesome_app_v1.0.0.apk

Build all formats #

flutterchi all

This will build APK, App Bundle, and (on Windows) EXE files.

🤝 Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License #

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author #

Created with ❤️ for Flutter developers

🔗 Links #

• pub.dev
• GitHub Repository
• Issue Tracker
• Flutter Documentation

⭐ Support #

If you find this package useful, please consider giving it a star on GitHub!

Happy Building! 🎉