flutter-build-cli
v1.0.3
Published
CLI tool for building and managing Flutter apps
Downloads
5
Readme
Flutter Build CLI
Flutter Build CLI is a Node.js command-line tool that simplifies the process of building a Flutter APK, renaming it based on your project's package name, package version, environment, and the current date/time.
Features
- Automated Build: Select your desired build mode (debug, release, profile) and environment (dev, uat, prod).
- Custom APK Naming: Automatically rename the built APK using the package name, package version, environment, and timestamp.
- Interactive CLI: User-friendly, interactive prompts guide you through the build and upload process.
Prerequisites
Before using this CLI, ensure you have the following installed:
- Node.js (v14.x or later)
- Flutter SDK (v2.x or later)
Installation
- Clone this repository to your local machine:
git clone <repository_url>
- Navigate to the project directory:
cd flutter-build-cli
- Install the dependencies:
npm install
- Make the script executable:
chmod +x index.js
- Optionally, link the CLI tool globally:
npm link
Usage
To use the Flutter Build CLI:
Navigate to the root directory of your Flutter project:
cd /path/to/your/flutter/project
Run the CLI tool:
flutter-build-cli
Follow the interactive prompts:
- Select the build mode (debug, release, profile).
- Select the environment (dev, uat, staging, prod).
- Choose whether to upload the APK to OneDrive.
Example
Here’s a sample session using the CLI:
$ flutter-build-cli
Package name: Flutter App
Selected build mode: release
Selected environment: prod
Running command: flutter build apk --target lib/main.dart --release
Build output: ...
APK renamed to: Flutter App PROD 1.0.0+1 (20240814-153045).apk