Formie comes with a number of command line utilities that can be run on-demand, or on a set schedule.
Refer to the Craft docs (opens new window) on available options.
./craft resave/formie-forms --update-search-index=1You can bulk delete forms with this command.
| Option | Description |
|---|---|
--form-handle | The form handle(s) to delete. Can be set to multiple comma-separated handles. |
--form-id | The form ID(s) to delete. Can be set to multiple comma-separated IDs. |
./craft formie/forms/delete --form-handle=form1,anotherFormRefer to the Craft docs (opens new window) on available options.
./craft resave/formie-submissions --form-id=1234 --update-search-index=1For a provided submission, run the provided integration.
| Option | Description |
|---|---|
--submission-id | The submission ID(s) to use data for. Can be set to multiple comma-separated IDs. |
--integration | The handle of the integration to trigger. |
./craft formie/submissions/run-integration --submission-id=12345 --integration=mailchimpFor a provided submission, send the provided notification.
| Option | Description |
|---|---|
--submission-id | The submission ID(s) to use data for. Can be set to multiple comma-separated IDs. |
--notification-id | The ID of the notification to trigger. |
./craft formie/submissions/send-notification --submission-id=12345 --notification-id=12A cleanup tasks to ensure fields aren't orphaned. Not normally required.
./craft formie/gc/delete-orphaned-fieldsA cleanup task to ensure Synced Fields are neat. Not normally required.
./craft formie/gc/prune-syncsDeletes any incomplete submissions that exceed the "Maximum Incomplete Submission Age" plugin setting.
./craft formie/gc/prune-incomplete-submissionsDeletes any submissions that exceed your data retention form settings.
./craft formie/gc/prune-data-retention-submissionsA cleanup task to ensure deleted forms have their content tables also deleted. Not normally required.
./craft formie/gc/prune-content-tablesA cleanup task for content tables to ensure unnecessary field columns are removed. Not normally required.
./craft formie/gc/prune-content-table-fieldsEach of the above commands are also run automatically through Craft's Garbage Collection (opens new window), so there's no need to add these commands unless you want fine-grained control over when they run.
You can bulk delete submissions with this command.
| Option | Description |
|---|---|
--form-handle | The form handle(s) to delete submissions from. Can be set to multiple comma-separated handles. |
--form-id | The form ID(s) to delete submissions from. Can be set to multiple comma-separated IDs. |
--incomplete-only | Whether to delete only incomplete submissions. |
--spam-only | Whether to delete only spam submissions. |
./craft formie/submissions/delete --form-handle=form1,anotherFormYou can bulk delete sent notifications with this command.
| Option | Description |
|---|---|
--form-handle | The form handle(s) to delete sent notifications for. Can be set to multiple comma-separated handles. |
--form-id | The form ID(s) to delete sent notifications for. Can be set to multiple comma-separated IDs. |
./craft formie/sent-notifications/delete --form-handle=form1,anotherFormYou can run the migrations from either Sprout Forms or Freeform via the command line. This would be an ideal approach if you have a large number of submissions or complex forms to migrate.
| Option | Description |
|---|---|
--form-handle | The Sprout Forms handle(s) to migrate. Can be set to multiple comma-separated handles. Omit to migrate all. |
./craft formie/migrate/migrate-sprout-forms --form-handle=form1,anotherForm| Option | Description |
|---|---|
--form-handle | The Freeform form handle(s) to migrate. Can be set to multiple comma-separated handles. Omit to migrate all. |
./craft formie/migrate/migrate-freeform4 --form-handle=form1,anotherForm./craft formie/migrate/migrate-freeform5 --form-handle=form1,anotherForm