Usage & Commands
Flutter Release X provides a focused set of commands to build, release, notify, and manage your application pipelines — all from your terminal.
tip
For help on any command, run frx <command> --help.
Core Commands
| Command | Description |
|---|---|
frx init | Generate a starter config.yaml with hooks, pipeline examples, and all options. |
frx build | Build the release app, upload to cloud, generate QR code & download link. |
frx build -s | Display the current config file path for quick verification. |
frx build -c <path> | Use a custom config file instead of the default config.yaml. |
frx build --target all | Build for all supported platforms (Android, iOS, Web, macOS, Windows, Linux). |
frx build --pipeline <name> | Run a specific named pipeline via the build command. |
frx pipeline list | List all configured pipelines with their descriptions and step counts. |
frx pipeline validate | Validate your pipeline config and show detailed, actionable errors. |
frx pipeline run <name> | Run a specific named pipeline. |
frx pipeline help-all | Show a complete feature reference for pipeline configuration. |
frx hooks install | Install all enabled git hooks into .git/hooks/. |
frx hooks install --dry-run | Preview what would be installed without writing any files. |
frx hooks uninstall | Remove all FRX-managed git hooks. |
frx hooks uninstall --hook <name> | Remove one specific hook. |
frx hooks list | Show all configured hooks and their install status. |
frx hooks run <name> | Manually trigger a hook by name. |
frx hooks validate | Validate your hooks config. |
frx notify -p slack -m 'msg' | Send a custom notification to Slack. |
frx notify -p teams -m 'msg' | Send a custom notification to Microsoft Teams. |
frx check-update | Manually check if a new version of FRX is available. |
frx version | Display the currently installed version. |
CLI Flags & Options
| Option | Alias | Values | Description |
|---|---|---|---|
--target | -t | all, android, ios, macos, windows, web, linux | Target platform(s) for the build command. |
--platform | -p | slack, teams | Notification platform for the notify command. |
--message | -m | "your message" | Custom notification message text. |
--config | -c | path/to/config.yaml | Path to a custom configuration file. |
--show-config | -s | — | Show the current config file path. |
--pipeline | — | pipeline-name | Run a specific named pipeline. |
Pipeline Commands
FRX v0.6.0 introduces a dedicated pipeline command group for managing multi-step workflows:
# List all pipelines
frx pipeline list
# Check for errors before running
frx pipeline validate
# Run a specific pipeline by name
frx pipeline run my-pipeline
# Full pipeline feature reference
frx pipeline help-all
🪝 Git Hooks Commands
FRX ships a Husky-like git hooks system. Define hooks in config.yaml and install them once:
# Install all enabled hooks
frx hooks install
# Preview without writing files
frx hooks install --dry-run
# See all hooks and their status
frx hooks list
# Manually trigger a hook (for testing)
frx hooks run pre-commit
# Remove all FRX-managed hooks
frx hooks uninstall
📖 See the Git Hooks Reference and Hooks Cookbook for full examples.
🔄 Automatic Update Checking
FRX silently checks for new versions in the background whenever you run a command (results cached for 24 hours).
- Non-blocking: Update checks run asynchronously — your commands run at full speed.
- Smart caching: Only checks once every 24 hours to avoid excessive network calls.
- In-place notifications: If an update is found, a friendly prompt appears after your command completes.
Manual Check
Force a fresh update check at any time:
frx check-update
Update FRX
dart pub global activate flutter_release_x
Or visit the pub.dev package page for release notes.