flutterflow_cli 0.0.33
flutterflow_cli: ^0.0.33 copied to clipboard
Command-line client for FlutterFlow. Export code from FlutterFlow projects and use FlutterFlow AI to build and edit your apps declaratively from the terminal.
FlutterFlow CLI #
Build, edit, and ship FlutterFlow apps from your terminal. ⚡
One CLI, two tools:
flutterflow ai— built for agents. A declarative Dart tool for building and editing FlutterFlow projects, with an MCP server so Claude Code, Codex, Gemini, Cursor, and GitHub Copilot can drive your project the same way they drive the rest of your codebase.flutterflow export-code— pull a Flutter codebase out of any FlutterFlow project and into your editor.
Install #
dart pub global activate flutterflow_cli
You'll need an API token. Grab one at https://app.flutterflow.io/account.
export FLUTTERFLOW_API_TOKEN=<your token>
FlutterFlow AI 🤖 #
Built for agents #
flutterflow ai was designed from day one for AI coding agents. It exposes your FlutterFlow project — pages, components, data, actions, theme — as a declarative Dart surface, and ships an MCP server so your agent can read, plan, and apply changes to the project alongside the rest of your codebase.
Use it with Claude Code, OpenAI Codex, Gemini, Cursor, GitHub Copilot, or any other MCP-aware coding assistant. You can also drive every command directly from the terminal — agents and humans share the same surface.
Platform support:
flutterflow aicurrently runs on macOS only. Windows support is coming soon.
Quick start ⚡ #
# 1. Install the CLI
dart pub global activate flutterflow_cli
# 2. Scaffold a workspace — the init wizard will prompt you for the rest
flutterflow ai init my-app
# 3. Hop in
cd my-app
# 4. Open your agent of choice — Claude Code, Codex, Gemini, Cursor, Copilot —
# and let it drive. The workspace ships everything an MCP-aware agent needs.
To run the MCP server explicitly (or wire it into your agent's MCP config):
flutterflow ai mcp --workspace "$(pwd)"
The toolbox 🧰 #
Run these from inside a FlutterFlow AI workspace — agents call them, and so can you.
| Build | run, validate — author project changes as Dart and apply them. |
| Explore | inspect, resources, search, status — read your project's structure from the terminal. |
| AI integration | mcp — expose your workspace to Claude Code, Codex, Gemini, Cursor, Copilot, and other MCP-aware assistants. |
| Plan & audit | plan, trace, history — capture intent, replay runs, see what shipped. |
| Diagnose | doctor, context-check, precache — keep the workspace healthy. |
| Stay current | upgrade, refresh-workspace, refresh-context — pull the latest tooling and project context. |
| Learn | docs [topic] — browse FlutterFlow AI docs without leaving the terminal. |
Run flutterflow ai --help from inside a workspace for the full command list and per-command flags.
Export Code #
Pull a Flutter codebase from any FlutterFlow project.
flutterflow export-code \
--project <project id> \
--dest <output folder> \
--[no-]include-assets \
--[no-]fix \
--[no-]parent-folder \
--[no-]as-module \
--[no-]as-debug \
--[no-]include-export-manifest
- Instead of passing
--tokenyou can set theFLUTTERFLOW_API_TOKENenvironment variable. - Instead of passing
--projectyou can set theFLUTTERFLOW_PROJECTenvironment variable. - Updating an existing checkout? Add a
.flutterflowignoreat the root of the output folder to protect files you don't want overwritten (globbing syntax).
Flags #
| Flag | Abbreviation | Usage |
|---|---|---|
--project |
-p |
[Required or environment variable] Project ID. |
--token |
-t |
[Required or environment variable] API Token. |
--dest |
-d |
[Optional] Output folder. Defaults to the current directory if none is specified. |
--[no-]include-assets |
None | [Optional] Whether to include media assets. Defaults to false. |
--[no-]include-export-manifest |
None | [Optional] Whether to include .flutterflow/export_manifest.json so tools can map FlutterFlow entities to generated files. Defaults to false. |
--branch-name |
-b |
[Optional] Which branch to download. Defaults to main. |
--[no-]fix |
None | [Optional] Whether to run dart fix on the downloaded code. Defaults to false. |
--[no-]parent-folder |
None | [Optional] Whether to download code into a project-named sub-folder. If true, downloads all project files directly to the specified directory. Defaults to true. |
--[no-]as-module |
None | [Optional] Whether to generate the project as a Flutter module. Defaults to false. |
--[no-]as-debug |
None | [Optional] Whether to generate the project with debug logging to be able to use FlutterFlow Debug Panel inside the DevTools. Defaults to false. |
--project-environment |
None | [Optional] Which project environment to be used. If empty, the current environment in the project will be used. |
Deploy Firebase #
Push your project's Firebase configuration to your Firebase project.
Prerequisites #
npm and firebase-tools must be installed. Follow the instructions at https://firebase.google.com/docs/cli#install_the_firebase_cli.
Usage #
flutterflow deploy-firebase --project <project id> --[no-]append-rules --token <token>
- Instead of passing
--tokenyou can set theFLUTTERFLOW_API_TOKENenvironment variable. - Instead of passing
--projectyou can set theFLUTTERFLOW_PROJECTenvironment variable.
Flags #
| Flag | Abbreviation | Usage |
|---|---|---|
--project |
-p |
[Required or environment variable] Project ID. |
--token |
-t |
[Required or environment variable] API Token. |
--append-rules |
-a |
Whether to append to existing Firestore rules instead of overwriting them. |
Issues #
Please file any issues in the FlutterFlow issues repo.
License #
FlutterFlow CLI is distributed under the Business Source License 1.1. You may use it in production solely in connection with FlutterFlow products and services. You may not use it to build, offer, or operate a competing visual application builder, low-code/no-code platform, or code generation tool. The license converts to Apache 2.0 on April 22, 2055. For commercial licensing inquiries, contact support@flutterflow.io.