Skip to content

📝 Update filtered exports section with .flutterflowignore example #306

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 5 commits into from
Mar 27, 2025
Merged
Changes from 1 commit
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
25 changes: 23 additions & 2 deletions docs/testing-deployment-publishing/exporting-code/ff-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,28 @@ To use the CLI, you'll need to create an API token and use it in your requests.

## 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.
If you are updating an existing project and do not want certain files to be changed during a code export, you can create a `.flutterflowignore` file in the root of your project directory. This file should contain a list of files to be ignored using globbing syntax.

### **Example:**
If your project is located at:
```
/Users/yourname/projects/my_flutterflow_app/
```
Then, place the `.flutterflowignore` file in:
```
/Users/yourname/projects/.flutterflowignore
```

### **Example `.flutterflowignore` contents:**
```
my_flutterflow_app/android/app/build.gradle # Prevents FlutterFlow from overwriting native Android build configuration
my_flutterflow_app/ios/Runner/Info.plist # Keeps iOS app metadata unchanged
my_flutterflow_app/web/index.html # Ensures custom modifications to the web entry file are retained
```
This ensures that the specified files and directories are not overwritten during code export.

For more details on globbing syntax, refer to [this guide](https://pub.dev/packages/glob#syntax).


## FAQ
<details>
Expand All @@ -87,4 +108,4 @@ dart pub global activate flutterflow_cli
```
This should update the CLI and fix the issue.
</p>
</details>
</details>
Loading