FlutterFlow CLI client: download code from your FlutterFlow project to your device for local running or deployment.
API access is available only to users with active subscriptions. Visit https://app.flutterflow.io/account to generate your API token.
dart pub global activate flutterflow_cli
flutterflow export-code --project <project id> --dest <output folder> --[no-]include-assets --token <token> --[no-]fix --[no-]parent-folder --[no-]as-module --[no-]as-debug --[no-]include-export-manifest
- Instead of passing
--tokenyou can setFLUTTERFLOW_API_TOKENenvironment variable. - Instead of passing
--projectyou can setFLUTTERFLOW_PROJECTenvironment variable.
In case you are updating an existing project and you don't want existing files to be changed, you can create a .flutterflowignore file at the root of the output folder
with a list of files to be ignored using globbing syntax.
| 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. |
npm and firebase-tools must be installed in order to deploy to Firebase. You can follow the instructions at https://firebase.google.com/docs/cli#install_the_firebase_cli.
flutterflow deploy-firebase --project <project id> --[no]-append-rules --token <token>
- Instead of passing
--tokenyou can setFLUTTERFLOW_API_TOKENenvironment variable. - Instead of passing
--projectyou can setFLUTTERFLOW_PROJECTenvironment variable.
| 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. |
Please file any issues in this repository.