Skip to content

Added Environment Command Option #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions docs/testing-deployment-publishing/exporting-code/ff-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,27 @@ To use the CLI, you'll need to create an API token and use it in your requests.

| Flag | Behavior | Default |
| --- | --- | --- |
| --dest / -d | Specifies a destination folder other than the current directory | Current directory |
| --[no]-include-assets | Option to download assets (images, GIFs). Useful for consecutive code exports if the assets folder hasn't changed | False |
| --branch-name / -b | Downloads from a specific branch | Main |
| --[no]-fix | Option to run dart fix on the code after downloading | False |
| --[no]-parent-folder | Option to download the code into a subfolder instead of directly into the directory | False |
| --dest / -d | Specifies a destination folder other than the current directory. | Current directory |
| --[no]-include-assets | Option to download assets (images, GIFs). Useful for consecutive code exports if the assets folder hasn't changed. | False |
| --branch-name / -b | Downloads from a specific branch. | Main |
| --[no]-fix | Option to run dart fix on the code after downloading. | False |
| --[no]-parent-folder | Option to download the code into a subfolder instead of directly into the directory. | False |
| --[no]-as-module | Whether to generate the project as a Flutter module. | False |
| --[no]-as-debug | Whether to generate the project with debug logging to be able to use FlutterFlow Debug Panel inside the DevTools. | False |
| --project-environment | Which [development environment](../development-environments/development-environments.md) to be used. If empty, the current environment in the project will be downloaded. | Current environment |

## Filtered exports

We've developed [a solution](https://github.com/krabhishek/flutterflow-filtered-pull) that allows you to use the CLI tool without overwriting specific files or directories. This is especially useful if you're managing code outside of FlutterFlow and want to prevent it from being overwritten during a code export.
We've developed [a solution](https://github.com/krabhishek/flutterflow-filtered-pull) that allows you to use the CLI tool without overwriting specific files or directories. This is especially useful if you're managing code outside of FlutterFlow and want to prevent it from being overwritten during a code export.

## FAQ
<details>
<summary>I am getting an error as FormatException: Missing argument for…</summary>
<p>
This error likely indicates that you haven't correctly entered the command option along with its value. Double-check that all required information has been entered. If everything is correct and you're still encountering the error, it might be due to using an outdated version of the FlutterFlow CLI. To resolve this, you can update to the latest version by running the installation command:
```
dart pub global activate flutterflow_cli
```
This should update the CLI and fix the issue.
</p>
</details>