Console Commands

Formie comes with a number of command line utilities that can be run on-demand, or on a set schedule.

Forms

Re-save Forms

Refer to the Craft docs (opens new window) on available options.

./craft resave/formie-forms --update-search-index=1

Delete Forms

You can bulk delete forms with this command.

./craft formie/forms/delete --form-handle=form1,anotherForm

Import/Export

List Forms

Lists all available Formie forms that can be exported or imported.

./craft formie/forms/list

Export Forms

Export Formie forms as JSON files. Requires form IDs or handles as a comma-separated list.

./craft formie/forms/export 1,contact-form,newsletter

Import Form

Import a Formie form from a JSON file.

./craft formie/forms/import formie-contact-form.json

Import All Forms

Import all Formie form JSON files from a folder.

./craft formie/forms/import-all

Submissions

Re-save Submissions

Refer to the Craft docs (opens new window) on available options.

./craft resave/formie-submissions --form-id=1234 --update-search-index=1

Run Integrations

For a provided submission, run the provided integration.

./craft formie/submissions/run-integration --submission-id=12345 --integration=mailchimp

Send Email Notification

For a provided submission, send the provided notification.

./craft formie/submissions/send-notification --submission-id=12345 --notification-id=12

Cron

Run Scheduled Tasks

Runs Formie tasks that should be scheduled on cron: cleanup/retention and due scheduled reports.

Schedule this command on production sites — for example, hourly:

./craft formie/cron/run

Use --only or the skip flags when you want separate cron schedules — for example, daily cleanup and hourly reports:

# Daily cleanup at 3am
0 3 * * * /path/to/craft formie/cron/run --only=gc

# Hourly scheduled reports
0 * * * * /path/to/craft formie/cron/run --only=reports

Craft's garbage collection (opens new window) still runs Formie cleanup as a best-effort fallback on web requests, but production sites should not rely on it.

Reports

Run Scheduled Reports

Sends any enabled scheduled reports that are due. This is included in ./craft formie/cron/run, or you can schedule it separately — for example, every hour — so scheduled report deliveries run automatically.

./craft formie/reports/run-scheduled

Cleanup

Run All Cleanup Tasks

Runs every Formie cleanup and retention task. This is included in ./craft formie/cron/run, or you can schedule it separately — for example, daily:

./craft formie/gc/run

Prune Incomplete Submissions

Deletes any incomplete submissions that exceed the "Maximum Incomplete Submission Age" plugin setting.

./craft formie/gc/prune-incomplete-submissions

Prune Data Retention Submissions

Deletes any submissions that exceed your data retention form settings.

./craft formie/gc/prune-data-retention-submissions

Prune Sent Notifications

Deletes sent notifications that exceed the plugin's maximum age setting.

./craft formie/gc/prune-sent-notifications

Prune Submission States

Deletes stale submission draft state records.

./craft formie/gc/prune-submission-states

Prune Draft Storage

Deletes expired submission draft storage rows.

./craft formie/gc/prune-draft-storage

Prune File Upload Asset Retention

Deletes uploaded assets that exceed a File Upload field's asset retention setting while keeping the submission record.

./craft formie/gc/prune-file-upload-asset-retention

Prune Stale Pending Uploads

Deletes unfinalized staged File Upload assets that exceed the plugin's maximum incomplete submission age.

./craft formie/gc/prune-stale-pending-uploads

Prune Report Exports

Deletes expired report export files.

./craft formie/gc/prune-report-exports

Delete Submissions

You can bulk delete submissions with this command.

./craft formie/submissions/delete --form-handle=form1,anotherForm

Delete Sent Notifications

You can bulk delete sent notifications with this command.

./craft formie/sent-notifications/delete --form-handle=form1,anotherForm

Migration

You can run the migrations from either Sprout Forms or Freeform via the command line. This is useful if you have a large number of submissions or complex forms to migrate.

Migrate Sprout Forms

./craft formie/migrate/sprout-forms --form-handle=form1,anotherForm

Migrate Freeform

./craft formie/migrate/freeform4 --form-handle=form1,anotherForm

./craft formie/migrate/freeform5 --form-handle=form1,anotherForm