Fluxy
Fundamentals

Fluxy CLI

The official command-line tool for Fluxy projects.

Fluxy CLI

The Fluxy CLI facilitates project scaffolding, accelerated development, and cloud integration. It is designed to automate the heavy lifting of project management and DevOps.

Installation

Install the Fluxy CLI globally via Dart:

dart pub global activate fluxy

Core Commands

fluxy init <app_name>

Scaffolds a new Fluxy project with the official architecture, boilerplate, and pre-configured state management.

fluxy init my_awesome_app

fluxy run

The optimized development runner for Fluxy projects. It provides faster hot-reloads and environment-specific optimizations compared to standard runners.

fluxy run

fluxy doctor

Checks your environment for Flutter and Fluxy compatibility and reports potential issues.

fluxy doctor

fluxy serve

Launches a local Over-The-Air (OTA) server for instant development and testing of remote manifests. This allows you to test SDUI (Server-Driven UI) changes locally before deploying.

fluxy serve

Cloud Integration

Fluxy CLI provides built-in tools for CI/CD and cloud-based build systems.

fluxy cloud build <android|ios>

Automatically configures GitHub Actions and cloud build environments for automated builds. It handles signing configurations and dependency management.

fluxy cloud build android

fluxy cloud deploy

Sets up and executes automated deployment pipelines to TestFlight (iOS) and Google Play (Android). It automates the submission process and metadata management.

fluxy cloud deploy

Module Management (v1.0.0+)

Manage your project's modular dependency tree and internal plugin registry.

fluxy module add <name>

Installs a platform module via pub add and automatically regenerates the architectural registry in lib/core/registry/fluxy_registry.dart.

fluxy module add connectivity

fluxy module list

Displays all available and installed platform modules in the Fluxy ecosystem.

fluxy module list

Generators & Blueprints

Generate components and boilerplate quickly to maintain project consistency.

fluxy g <name> <type> (Blueprints)

Generates complete, working feature solutions based on official Blueprints. Currently supports professional scaffolding for common features.

# Generate a complete login feature
fluxy g auth login

# Generate a social feed feature
fluxy g social feed

fluxy g:page <Name>

Generates a new View, Controller, and Route entry.

fluxy g:page Home

fluxy g:controller <Name>

Generates a standalone reactive controller for global or modular state.

fluxy g:controller Auth

fluxy generate plugin <Name>

Generates a new framework plugin (extension) scaffold following the FluxyPlugin architecture.

fluxy generate plugin MyAnalytics

fluxy generate layout <Name>

Generates a reusable layout template for organizing complex UI structures.

fluxy generate layout Dashboard

fluxy generate model <Name>

Generates a data model with built-in JSON serialization and reactive properties.

fluxy generate model UserProfile

On this page