share_my_apk - Dart API docs

The Ultimate Flutter APK Build & Upload Automation Tool

Stop the build-and-drag-drop dance! 💃 Your mouse deserves a break.

From code to shareable link in one command ⚡

Automate your Flutter Android APK builds and uploads with the power of magic (and some really good code)

Manual flutter build apk commands
Drag & drop APKs to upload sites
Manually manage file names and versions
Deal with upload failures and size limits
Remember different tokens for different services
Copy-paste download links manually

One command builds and uploads
Automatic FVM detection and Flutter commands
Comprehensive build pipeline (clean, pub get, gen-l10n)
Fully automated - no manual confirmations needed
Smart file naming with versions
Robust error handling and retries
Unified configuration management
Instant shareable links

✨ What Makes It Special?

🏆 Feature	🎯 Benefit	🔥 Why It Matters
🚀 One-Command Magic	`share_my_apk` does it all	Save hours of manual work
🔧 Comprehensive Pipeline	Clean, deps, l10n, build	Enterprise-grade reliability
☁️ Multi-Provider Support	Diawi + Gofile.io	Never worry about size limits
🔄 Smart Auto-Switching	Diawi → Gofile for 70MB+ files	Zero upload failures
📝 Smart Configuration	YAML-based setup	Set once, use forever
🛡️ Reliable & Tested	Production-ready	Works every time
🎨 Flexible Organization	Custom naming & folders	Keep your builds organized

📚 Usage

See the Quick Start and Usage Examples sections below for detailed instructions.

⬇️ Installation

Refer to the Installation Options section for how to install share_my_apk.

💡 Examples

Check out the Usage Examples section for various ways to use this tool.

🎉 What's New in v0.5.0?

🚀 Fully Automated & Comprehensive Build Pipeline!

✨ Key Improvements

✅ Comprehensive Build Pipeline - Automatic FVM detection, flutter clean, pub get, and localization generation
✅ Fully Automated Uploads - Removed confirmation dialog for streamlined CI/CD workflows
✅ Enhanced Reliability - Professional-grade build process with step-by-step logging
✅ Enterprise-Ready - Perfect for production environments and automated deployments

👀 Click to see the new logs in action!

 [32mℹ️ [12:55:55] 🚀 Starting comprehensive APK build (mode: release)... [0m
 [32mℹ️ [12:55:55] Using Flutter command: fvm flutter [0m
 [32mℹ️ [12:55:55] 🧹 [1/4] Cleaning project... [0m
 [32mℹ️ [12:55:58] 📦 [2/4] Getting dependencies... [0m
 [32mℹ️ [12:56:02] 🌍 [3/4] Generating localizations... [0m
 [32mℹ️ [12:56:04] 🔨 [4/4] Building APK (release mode)... [0m
 [36m✨ [12:56:15] Build output: ✓ Built build/app/outputs/flutter-apk/app-release.apk (55.1MB) [0m
 [32mℹ️ [12:56:15] ✅ APK built successfully: ./build/app/outputs/flutter-apk/app-release.apk [0m
 [32mℹ️ [12:56:15] Uploading APK... [0m
 [32mℹ️ [12:56:15] File: ./moonnote_1.0.1+a2_2025_07_09_12_55_55.apk [0m
 [32mℹ️ [12:56:15] Size: 55.10 MB [0m
 [32mℹ️ [12:56:15] Provider: diawi [0m
 [32mℹ️ [12:56:25] Upload successful: https://i.diawi.com/SzSiZc [0m
 [32m╔═════════════════════╗ [0m
 [32m║ APK successfully uploaded to diawi!                                    ║ [0m
 [32m║ Download link: https://i.diawi.com/SzSiZc                              ║ [0m
 [32m╚═════════════════════╝ [0m

⚡ Quick Start

1️⃣ Install

dart pub global activate share_my_apk

2️⃣ Configure

share_my_apk --init

3️⃣ Build & Upload

share_my_apk

Get instant download link! 🔗

Installation Options

🌍 Global Installation

dart pub global activate share_my_apk

Perfect for CLI usage across all projects

📦 Project Dependency

dev_dependencies:
  share_my_apk: ^0.5.0

Perfect for team projects and CI/CD pipelines

🎮 Usage Examples

🔧 Basic Usage

# Initialize configuration (one-time setup)
share_my_apk --init

# Build and upload with default settings
share_my_apk

# Use specific provider
share_my_apk --provider gofile

# Custom naming and environment
share_my_apk --name MyApp_Beta --environment staging

# Debug build
share_my_apk --no-release

# Skip build pipeline steps (for faster builds)
share_my_apk --no-clean --no-pub-get

⚙️ Advanced Configuration

Create share_my_apk.yaml in your project root:

# Provider settings
provider: diawi

# API tokens
diawi_token: your_diawi_token_here
gofile_token: your_gofile_token_here

# Build settings
release: true
path: .

# Build pipeline controls
clean: true          # Run flutter clean
pub-get: true        # Run flutter pub get
gen-l10n: true       # Generate localizations

# File organization
name: MyApp_Production
environment: prod
output-dir: build/releases

🔬 Library Usage

import 'package:share_my_apk/share_my_apk.dart';

void main() async {
  // Build APK with comprehensive pipeline
  final buildService = FlutterBuildService();
  final apkPath = await buildService.build(
    release: true,
    customName: 'MyApp_Beta',
    environment: 'staging',
    clean: true,           // Run flutter clean
    getPubDeps: true,      // Run flutter pub get
    generateL10n: true,    // Generate localizations
  );

  // Upload to cloud
  final uploader = UploadServiceFactory.create('gofile');
  final downloadLink = await uploader.upload(apkPath);
  
  print('🚀 Download link: $downloadLink');
}

🎯 Command Reference

Command	Alias	Description	Example
`--help`	`-h`	Show help message	`share_my_apk --help`
`--init`	-	Generate config file	`share_my_apk --init`
`--path`	`-p`	Project path	`share_my_apk -p /my/project`
`--provider`	-	Upload provider	`share_my_apk --provider gofile`
`--name`	`-n`	Custom APK name	`share_my_apk -n MyApp_Beta`
`--environment`	`-e`	Environment folder	`share_my_apk -e staging`
`--output-dir`	`-o`	Output directory	`share_my_apk -o build/apks`
`--diawi-token`	-	Diawi API token	`share_my_apk --diawi-token abc123`
`--gofile-token`	-	Gofile API token	`share_my_apk --gofile-token xyz789`
`--release`	-	Release build (default)	`share_my_apk --release`
`--no-release`	-	Debug build	`share_my_apk --no-release`
`--clean`	-	Run flutter clean (default)	`share_my_apk --clean`
`--no-clean`	-	Skip flutter clean	`share_my_apk --no-clean`
`--pub-get`	-	Run flutter pub get (default)	`share_my_apk --pub-get`
`--no-pub-get`	-	Skip flutter pub get	`share_my_apk --no-pub-get`
`--gen-l10n`	-	Generate localizations (default)	`share_my_apk --gen-l10n`
`--no-gen-l10n`	-	Skip localization generation	`share_my_apk --no-gen-l10n`

💡 Pro Tip: Share My APK automatically switches from Diawi to Gofile for files >70MB!

🚀 Fully Automated Workflow

Share My APK now provides a completely automated experience, perfect for CI/CD pipelines and production workflows.

🧹 [1/4] Cleaning project...
📦 [2/4] Getting dependencies...
🌍 [3/4] Generating localizations...
🔨 [4/4] Building APK (release mode)...
ℹ️ [12:56:05] Uploading APK...
ℹ️ [12:56:05] File: /path/to/your/app.apk
ℹ️ [12:56:05] Size: 55.10 MB
ℹ️ [12:56:05] Provider: diawi

🛡️ Reliability & Quality

Share My APK is production-ready and thoroughly tested to ensure it works reliably in real-world scenarios.

✅ What We've Tested

✅ Large File Uploads - Successfully tested with 113MB+ APKs
✅ Network Resilience - Handles connection issues gracefully
✅ Provider Switching - Automatic fallback works seamlessly
✅ Build Pipeline - Comprehensive testing with FVM, clean builds, dependencies
✅ Edge Cases - Handles special characters, long paths, and more
✅ Cross-Platform - Works on Windows, macOS, and Linux
✅ CI/CD Ready - Fully automated for production deployments

Ready for your production workflow! 🚀

📁 File Organization Magic

Share My APK keeps your builds organized with smart naming:

output-directory/
├── environment/                    # Optional environment folder
│   ├── MyApp_1.0.0_2025_07_09_14_30_45.apk
│   ├── MyApp_1.0.1_2025_07_09_15_15_30.apk
│   └── ...
├── staging/
│   ├── MyApp_Beta_1.0.0_2025_07_09_12_00_00.apk
│   └── ...
└── prod/
    ├── MyApp_Production_1.0.0_2025_07_09_16_45_30.apk
    └── ...

Naming Pattern: {name}_{version}_{timestamp}.apk

📚 Need More Info?

📖 Resource	🎯 What's Inside
Release Notes	What's new and version history
Changelog	Detailed version changes

🎉 Ready to Get Started?

dart pub global activate share_my_apk
share_my_apk --init
share_my_apk

That's it! You're now sharing APKs like a pro! 🎯

💬 Need Help?

Made with ❤️ for the Flutter community

Because sharing should be simple, not a chore ✨

✨ What Makes It Special?

📚 Usage

⬇️ Installation

💡 Examples

🎉 What's New in v0.5.0?

✨ Key Improvements

⚡ Quick Start

1️⃣ Install

2️⃣ Configure

3️⃣ Build & Upload

Installation Options

🌍 Global Installation

📦 Project Dependency

🎮 Usage Examples

🔧 Basic Usage

⚙️ Advanced Configuration

🔬 Library Usage

🎯 Command Reference

🚀 Fully Automated Workflow

🛡️ Reliability & Quality

✅ What We've Tested

📁 File Organization Magic

📚 Need More Info?

🎉 Ready to Get Started?

💬 Need Help?

Libraries

share_my_apk package

🚀 Share My APK

🎯 Why Share My APK?

😩 Before Share My APK

🚀 After Share My APK

✨ What Makes It Special?

📚 Usage

⬇️ Installation

💡 Examples

🎉 What's New in v0.5.0?

✨ Key Improvements

⚡ Quick Start

1️⃣ Install

2️⃣ Configure

3️⃣ Build & Upload

4️⃣ Share

Installation Options

🌍 Global Installation

📦 Project Dependency

🎮 Usage Examples

🔧 Basic Usage

⚙️ Advanced Configuration

🔬 Library Usage

🎯 Command Reference

🚀 Fully Automated Workflow

🛡️ Reliability & Quality

✅ What We've Tested

📁 File Organization Magic

📚 Need More Info?

🎉 Ready to Get Started?

💬 Need Help?

Libraries

share_my_apk package