Visitar URL original
GitHub - fastforgedev/fastforge: Ship every app faster to your users — Build, package, and publish with one clear configuration. Target popular distribution formats and app stores while fitting naturally into your CI/CD pipeline. · GitHub
Skip to content
fastforgedevPublic

About

Ship every app faster to your users — Build, package, and publish with one clear configuration. Target popular distribution formats and app stores while fitting naturally into your CI/CD pipeline.

Topics

Resources

Stars

1.1k stars

Watchers

12 watching

Forks

Latest commit

 

History

612 Commits

Folders and files

Repository files navigation

Fastforge

Fastforge formerly Flutter Distributor

pub version pub downloads melos All Contributors

Ship every app faster to your users — Build, package, and publish with one clear configuration. Target popular distribution formats and app stores while fitting naturally into your CI/CD pipeline.

Warning

Rust Migration In Progress: The core of Fastforge is being rewritten in Rust to deliver better performance, a smaller install footprint, and zero runtime dependencies on the Dart SDK. The native CLI lives in apps/cli/ with its core libraries in crates/, and is developed in parallel with the existing Dart packages.

What this means for you:

  • The current Dart-based CLI (dart pub global activate fastforge) continues to work and receives bug fixes.
  • The Rust CLI is released as a native binary — no Dart or Flutter SDK required to run it. See the installation guide.
  • APIs and configuration formats are designed to remain compatible; any breaking changes will be clearly announced.
  • distribute_options.yaml and the release command are deprecated: they keep working for compatibility but get no new features. New configuration goes in .fastforge/ (project) or ~/.fastforge/ (machine), and new automation in local workflows.
  • Contributions, feedback, and bug reports on the Rust implementation are very welcome — see the Contributing section.

English | 简体中文


Documentation

Key Features

  • 🚀 One-Click Build: Support for Android APK/AAB, iOS IPA, OpenHarmony HAP/APP and more
  • 📦 Multi-Platform Release: Support for App Store, Google Play, Firebase, Pgyer, fir.im, etc.
  • 🔄 CI/CD Integration: Perfect integration with GitHub Actions, GitLab CI, and more
  • 🛠 Flexible Configuration: Support for multiple environments, flavors, and custom build arguments

Supported Package Formats

Supported Distribution Platforms

Installation

The native CLI installs as a standalone binary; see the installation guide. The Dart CLI installs with:

dart pub global activate fastforge

Windows users: After activation, ensure the pub cache bin directory is in your PATH:

  1. Open System Properties → Advanced → Environment Variables
  2. Under User variables, select Path → Edit
  3. Add %APPDATA%\Pub\Cache\bin and click OK
  4. Restart your terminal, then try fastforge --help

Quick Start

Note: This quick start uses the deprecated distribute_options.yaml and release command, which still work in both CLIs. For new projects, see Getting Started and local workflows.

  1. Add distribute_options.yaml to your project root:
variables:
  PGYER_API_KEY: "your api key" # Replace with your own API keys
output: dist/
releases:
  - name: dev
    jobs:
      # Build and publish APK to PGYER
      - name: release-dev-android
        package:
          platform: android
          target: apk
          build_args:
            target-platform: android-arm,android-arm64
            dart-define:
              APP_ENV: dev
        publish_to: pgyer

      # Build and publish IPA to PGYER
      - name: release-dev-ios
        package:
          platform: ios
          target: ipa
          build_args:
            export-options-plist: ios/dev_ExportOptions.plist
            dart-define:
              APP_ENV: dev
        publish_to: pgyer

Note: build_args are parameters supported by the flutter build command. Modify them according to your project requirements.

  1. Release your app:
fastforge release --name dev

CLI Commands

Package Your App

fastforge package --platform=android --targets=aab,apk

Publish a Package

fastforge publish --path dist/your-app-1.0.0+1-android.apk --targets pgyer

Release (Package + Publish)

fastforge release --name dev

Examples

Fastforge includes several example projects to help you get started:

Advanced Usage

Environment Variables

Fastforge supports using environment variables in your configuration files. This is useful for sensitive information like API keys:

variables:
  API_KEY: ${PGYER_API_KEY} # Uses the PGYER_API_KEY environment variable

CI/CD Integration

Fastforge works well in CI/CD environments. For example, with GitHub Actions:

jobs:
  build-and-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: subosito/flutter-action@v2
      - name: Install Fastforge
        run: dart pub global activate fastforge
      - name: Build and release
        run: fastforge release --name production
        env:
          API_KEY: ${{ secrets.API_KEY }}

Check the documentation for more detailed CI/CD integration examples.

Who's Using It?

  • Biyi - A convenient translation and dictionary app.
  • Qianji - A purely bookkeeping app.
  • Airclap - Send any file to any device. cross platform, ultra fast and easy to use.

Contributing

Development and CI use Flutter 3.47.6 stable and its bundled Dart 3.13.5 SDK. Add the Flutter SDK's bin directory to PATH and run flutter and dart directly. The CI version is configured in ci.yml. See AGENTS.md for repository setup and validation commands.

Contributions are welcome! If you'd like to help improve Fastforge:

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

Please make sure to update tests as appropriate and follow the existing code style.

Contributors

LiJianying
LiJianying

💻
Zero
Zero

💻
Kingkor Roy Tirtho
Kingkor Roy Tirtho

💻
LAIIIHZ
LAIIIHZ

💻
Tomohiro Ueki
Tomohiro Ueki

💻
Sven Gehring
Sven Gehring

💻
GargantuaX
GargantuaX

💻
Hiperion
Hiperion

💻
Reuben Turner
Reuben Turner

💻
Ankit Mahato
Ankit Mahato

📖
Tien Do Nam
Tien Do Nam

💻
zacks
zacks

💻
Mohammed  CHAHBOUN
Mohammed CHAHBOUN

💻
Prateek Sunal
Prateek Sunal

💻
lllgm
lllgm

💻
Arran Ubels
Arran Ubels

💻
Sherman Chu
Sherman Chu

💻 📖
DrSheppard
DrSheppard

📖
cranst0n
cranst0n

💻
duskygloom
duskygloom

💻
imnadev
imnadev

💻
jenken827
jenken827

💻
kecson
kecson

💻
zzqayy
zzqayy

💻
Add your contributions

License

MIT

Fastforge Studio

The Studio web client, local server, and shared packages live in this repository under the studio- package prefix. See the Studio development guide for setup and checks.

Agent Skills

Agent skills that teach Claude and other Agent-Skills-compatible harnesses how to use fastforge live in skills/. Install them with npx skills add fastforgedev/fastforge; see the skills guide for details.

About

Ship every app faster to your users — Build, package, and publish with one clear configuration. Target popular distribution formats and app stores while fitting naturally into your CI/CD pipeline.

Topics

Resources

Stars

1.1k stars

Watchers

12 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages