{"id":48603,"date":"2016-05-24T08:16:57","date_gmt":"2016-05-24T08:16:57","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/gravityformscli\/"},"modified":"2026-04-02T15:59:14","modified_gmt":"2026-04-02T15:59:14","slug":"gravityformscli","status":"publish","type":"plugin","link":"https:\/\/ug.wordpress.org\/plugins\/gravityformscli\/","author":14941374,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"1.9","stable_tag":"1.9","tested":"6.7.5","requires":"4.2","requires_php":"","requires_plugins":null,"header_name":"Gravity Forms CLI","header_author":"Rocketgenius","header_description":"","assets_banners_color":"6493c4","last_updated":"2026-04-02 15:59:14","external_support_url":"","external_repository_url":"","donate_link":"","header_plugin_uri":"https:\/\/gravityforms.com","header_author_uri":"https:\/\/gravityforms.com","rating":4.4,"author_block_rating":0,"active_installs":10000,"downloads":361096,"num_ratings":7,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","changelog"],"tags":{"1.0":{"tag":"1.0","author":"stevehenty","date":"2018-11-13 16:55:46"},"1.1":{"tag":"1.1","author":"stevehenty","date":"2020-04-13 11:22:50"},"1.2":{"tag":"1.2","author":"stevehenty","date":"2020-05-18 16:31:13"},"1.3":{"tag":"1.3","author":"stevehenty","date":"2020-07-20 09:41:04"},"1.4":{"tag":"1.4","author":"stevehenty","date":"2021-09-06 13:04:46"},"1.7":{"tag":"1.7","author":"rocketgenius","date":"2024-12-02 22:37:32"},"1.9":{"tag":"1.9","author":"rocketgenius","date":"2026-04-02 15:59:14"}},"upgrade_notice":[],"ratings":{"1":1,"2":0,"3":0,"4":0,"5":6},"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":3443386,"resolution":"128x128","location":"assets","locale":""},"icon-256x256.png":{"filename":"icon-256x256.png","revision":3443386,"resolution":"256x256","location":"assets","locale":""}},"assets_banners":{"banner-1544x500.png":{"filename":"banner-1544x500.png","revision":3443386,"resolution":"1544x500","location":"assets","locale":""},"banner-772x250.png":{"filename":"banner-772x250.png","revision":3443386,"resolution":"772x250","location":"assets","locale":""}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0","1.1","1.2","1.3","1.4","1.7","1.9"],"block_files":[],"assets_screenshots":[],"screenshots":[],"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[1655],"plugin_category":[],"plugin_contributors":[87061],"plugin_business_model":[],"class_list":["post-48603","plugin","type-plugin","status-publish","hentry","plugin_tags-gravity-forms","plugin_contributors-rocketgenius","plugin_committers-rocketgenius","plugin_committers-stevehenty"],"banners":{"banner":"https:\/\/ps.w.org\/gravityformscli\/assets\/banner-772x250.png?rev=3443386","banner_2x":"https:\/\/ps.w.org\/gravityformscli\/assets\/banner-1544x500.png?rev=3443386","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/gravityformscli\/assets\/icon-128x128.png?rev=3443386","icon_2x":"https:\/\/ps.w.org\/gravityformscli\/assets\/icon-256x256.png?rev=3443386","generated":false},"screenshots":[],"raw_content":"<!--section=description-->\n<p>The Gravity Forms CLI Add-On allows WP-CLI users to manage forms and entries and more on the command line.<\/p>\n\n<p><a href=\"https:\/\/docs.gravityforms.com\/category\/add-ons-gravity-forms\/wp-cli-add-on\/\">Documentation<\/a><\/p>\n\n<h4>Getting started<\/h4>\n\n<ul>\n<li><code>wp help gf<\/code><\/li>\n<li><code>wp help gf form<\/code><\/li>\n<li><code>wp help gf form field<\/code><\/li>\n<li><code>wp help gf form notification<\/code><\/li>\n<li><code>wp help gf entry<\/code><\/li>\n<li><code>wp help gf entry notification<\/code><\/li>\n<li><code>wp help gf install<\/code><\/li>\n<li><code>wp help gf setup<\/code><\/li>\n<li><code>wp help gf license<\/code><\/li>\n<li><code>wp help gf tool<\/code><\/li>\n<\/ul>\n\n<h4>Form Management<\/h4>\n\n<pre><code>wp gf form [command]\n<\/code><\/pre>\n\n<p>Commands:<\/p>\n\n<ul>\n<li>create - Creates a new form.<\/li>\n<li>delete - Deletes a form.<\/li>\n<li>duplicate - Duplicates a form.<\/li>\n<li>edit - Launch system editor to edit the Form configuration.<\/li>\n<li>export - Exports forms to a Gravity Forms Form export file.<\/li>\n<li>form_list - Lists the forms with entry count and view counts.<\/li>\n<li>get - Returns the form JSON.<\/li>\n<li>import - Imports forms from a Gravity Forms Form export file.<\/li>\n<li>update - Updates a form.<\/li>\n<\/ul>\n\n<h4>Field Management<\/h4>\n\n<ul>\n<li><code>wp gf form field [command]<\/code><\/li>\n<li><code>wp gf field [command]<\/code> (alias)<\/li>\n<\/ul>\n\n<p>Commands:<\/p>\n\n<ul>\n<li>create - Creates a field and adds it to a form.<\/li>\n<li>delete - Deletes a field.<\/li>\n<li>duplicate - Duplicates a field.<\/li>\n<li>edit - Launch system editor to edit the Field configuration.<\/li>\n<li>get - Returns the JSON representation of a field.<\/li>\n<li>list  - Displays a list of fields for a form.<\/li>\n<li>update - Updates a field.<\/li>\n<\/ul>\n\n<h4>Notification Management<\/h4>\n\n<ul>\n<li><code>wp gf form notification [command]<\/code><\/li>\n<li><code>wp gf notification [command]<\/code> (alias)<\/li>\n<\/ul>\n\n<p>Commands:<\/p>\n\n<ul>\n<li>create - Creates a new notification.<\/li>\n<li>delete - Deletes a notification.<\/li>\n<li>duplicate - Duplicates a notification.<\/li>\n<li>edit - Launch system editor to edit the notification configuration.<\/li>\n<li>list - Lists the notification.<\/li>\n<li>get - Returns the notification JSON.<\/li>\n<li>update - Updates a notification.<\/li>\n<\/ul>\n\n<h4>Entry Management<\/h4>\n\n<pre><code>wp gf entry [command]\n<\/code><\/pre>\n\n<p>Commands:<\/p>\n\n<ul>\n<li>create - Creates a new entry from either a JSON string with the raw entry or from field-value pairs.<\/li>\n<li>delete - Deletes an entry.<\/li>\n<li>duplicate - Duplicates an entry<\/li>\n<li>edit - Launch system editor to edit the JSON representation of the Entry.<\/li>\n<li>export - Exports entries.<\/li>\n<li>get - Returns a JSON representation of an entry.<\/li>\n<li>import - Imports entries.<\/li>\n<li>list - Displays a list of entries.<\/li>\n<li>update - Updates an entry.<\/li>\n<\/ul>\n\n<h4>Entry Notifications<\/h4>\n\n<pre><code>wp gf entry notification [command]\n<\/code><\/pre>\n\n<p>Commands:<\/p>\n\n<ul>\n<li>get - Returns the notifications for the given entry.<\/li>\n<li>send - Sends the notifications for the given entry.<\/li>\n<\/ul>\n\n<h4>License Management<\/h4>\n\n<pre><code>wp gf license [command]\n<\/code><\/pre>\n\n<p>Commands:<\/p>\n\n<ul>\n<li>update - Updates the license key for the installation.<\/li>\n<li>delete - Deletes the license key for the installation.<\/li>\n<\/ul>\n\n<h4>Misc Tools<\/h4>\n\n<pre><code>wp gf tool [command]\n<\/code><\/pre>\n\n<p>Commands:<\/p>\n\n<ul>\n<li>clear-transients<\/li>\n<li>empty-trash           Delete the trashed entries.<\/li>\n<li>verify-checksums      Verify Gravity Forms files against the checksums.<\/li>\n<li>system-report         Outputs the system report from the Forms &gt; System Status page. Supports \"status\" as an alias.<\/li>\n<\/ul>\n\n<h4>Installing Gravity Forms and Add-Ons<\/h4>\n\n<p>The above commands all require Gravity Forms to be installed. However, if Gravity Forms is not installed then you can use this add-on to install it along with all the other official Gravity Forms add-ons.<\/p>\n\n<p>The install command will download and install the latest version Gravity Forms available for auto-update and then run the database setup. The license key will be saved in the plugin settings.<\/p>\n\n<p>A valid license key is required either in the <code>GF_LICENSE_KEY<\/code> constant or the <code>--key<\/code> option.<\/p>\n\n<p>Examples:<\/p>\n\n<ul>\n<li><code>wp gf install --key=xxxxx<\/code><\/li>\n<li><code>wp gf install --key=xxxxx --activate<\/code><\/li>\n<li><code>wp gf install gravityformspolls --key=xxxxx<\/code><\/li>\n<li><code>wp gf install gravityformsquiz --key=xxxxx<\/code><\/li>\n<\/ul>\n\n<p>Once installed, the database can be set up or upgraded separately using the setup command. The command will not re-run the setup unless the <code>--force<\/code> flag is set.<\/p>\n\n<p>Examples:<\/p>\n\n<ul>\n<li><code>wp gf setup<\/code><\/li>\n<li><code>wp gf setup --force<\/code><\/li>\n<\/ul>\n\n<p>Gravity Forms and official add-ons can be updated using the update command.<\/p>\n\n<p>Examples:<\/p>\n\n<ul>\n<li><code>wp gf update<\/code><\/li>\n<li><code>wp gf update gravityformspolls<\/code><\/li>\n<\/ul>\n\n<p>Check the current version using the version command.<\/p>\n\n<p>Examples:<\/p>\n\n<ul>\n<li><code>wp gf version<\/code><\/li>\n<li><code>wp gf version gravityformspolls<\/code><\/li>\n<\/ul>\n\n<h4>Requirements<\/h4>\n\n<ol>\n<li>Wordpress 4.2+<\/li>\n<li>Gravity Forms 1.9.17.8<\/li>\n<li>WP-CLI version 1.0+<\/li>\n<\/ol>\n\n<h4>Support<\/h4>\n\n<p>If you find anything that needs fixing please open a support ticket at https:\/\/www.gravityforms.com\/open-support-ticket\/<\/p>\n\n<p>If you have any ideas for improvements please submit your idea at https:\/\/www.gravityforms.com\/gravity-forms-roadmap\/<\/p>\n\n<!--section=installation-->\n<p>wp plugin install gravityformscli --activate<\/p>\n\n<p>or<\/p>\n\n<pre><code>wp package install https:\/\/github.com\/gravityforms\/gravityformscli.git\n<\/code><\/pre>\n\n<p>or<\/p>\n\n<ol>\n<li>Download the zipped file.<\/li>\n<li>Extract and upload the contents of the folder to \/wp-contents\/plugins\/ folder<\/li>\n<li>Go to the Plugin management page of WordPress admin section and enable the 'Gravity Forms CLI' plugin<\/li>\n<\/ol>\n\n<!--section=changelog-->\n<h4>1.9<\/h4>\n\n<ul>\n<li>Updated the plugin to support installing packages through Packagist.<\/li>\n<\/ul>\n\n<h4>1.8<\/h4>\n\n<ul>\n<li>Fixed a bug where the verify checksums command fails even when it should succeed.<\/li>\n<\/ul>\n\n<h4>1.7<\/h4>\n\n<ul>\n<li>Fixed a bug that sometimes causes the form ID to be stored as a string.<\/li>\n<\/ul>\n\n<h4>1.6<\/h4>\n\n<ul>\n<li>Updated the plugin to support installing and updating Gravity SMTP.<\/li>\n<\/ul>\n\n<h4>1.5<\/h4>\n\n<ul>\n<li>Updated the plugin to allow its usage as a WP-CLI package.<\/li>\n<\/ul>\n\n<h4>1.4<\/h4>\n\n<ul>\n<li>Fixed an issue where the version comparison performed when using <code>wp gf update<\/code> with an add-on slug uses the Gravity Forms version number.<\/li>\n<li>Added support for using <code>--version=beta<\/code> with the <code>wp gf install<\/code> and <code>wp gf update<\/code> commands. Add-On beta releases are not currently supported.<\/li>\n<li>Fixed a fatal error which can occur when using the <code>wp gf version<\/code> command with an add-on slug when Gravity Forms is not active or not installed.<\/li>\n<\/ul>\n\n<h4>1.3<\/h4>\n\n<ul>\n<li>Fixed an error occurring when using the <code>wp gf form notification create<\/code> command.<\/li>\n<\/ul>\n\n<h4>1.2<\/h4>\n\n<ul>\n<li>Updated Gravity API domain.<\/li>\n<li>Updated the ids format of the <code>wp gf entry list<\/code> command to support the page-size and offset args. Credit: Ulrich Pogson.<\/li>\n<li>Updated the form export command to support the optional filename arg e.g. <code>wp gf form export 1 --filename=testing.json<\/code>. Credit: Timothy Decker.<\/li>\n<li>Fixed an issue where the <code>wp gf install<\/code> command could not network activate plugins.<\/li>\n<li>Fixed an error occurring when using the <code>wp gf form notification update<\/code> command without the notification-id arg.<\/li>\n<li>Fixed an issue with the <code>wp gf entry export<\/code> command.<\/li>\n<\/ul>\n\n<h4>1.1<\/h4>\n\n<ul>\n<li>Added support for start_date and end_date filters for the entry export command. e.g. <code>wp gf entry export 11 --start_date=\"2018-11-01\" --end_date=\"2018-11-11\"<\/code><\/li>\n<li>Added the <code>wp gf tool system-report<\/code> command and the <code>wp gf tool status<\/code> alias for outputting the system report from the Gravity Forms 2.2+ System Status page.<\/li>\n<li>Fixed an issue with the <code>wp gf install<\/code> command ending with an error message when no error occurred.<\/li>\n<li>Fixed an issue where old messages could continue to be displayed in the admin following a license key change.<\/li>\n<li>Fixed an \"invalid synopsis part\" warning and an \"unknown parameter\" error with the <code>wp gf form field update<\/code> command.<\/li>\n<li>Fixed the <code>wp gf form update<\/code> command using the wrong argument to get the existing form which could result in a form not found error.<\/li>\n<li>Fixed an issue with the <code>wp gf form create<\/code> command where missing field IDs are added automatically.<\/li>\n<\/ul>\n\n<h4>1.0<\/h4>\n\n<ul>\n<li>Added the <code>wp gf license<\/code> command.<\/li>\n<li>Fixed an issue with updating forms from an export file.<\/li>\n<\/ul>\n\n<h4>1.0-rc-1<\/h4>\n\n<ul>\n<li>Added the <code>--file<\/code> arg to the <code>wp gf form update<\/code> command to allow forms to be updated from an export file.<\/li>\n<li>Fixed a fatal error when using the install command.<\/li>\n<\/ul>\n\n<h4>1.0-beta-5<\/h4>\n\n<ul>\n<li>Added the <code>wp gf form notification<\/code> command.<\/li>\n<li>Added the <code>wp gf entry notification<\/code> command.<\/li>\n<li>Added the <code>wp gf version<\/code> command.<\/li>\n<li>Added the <code>wp gf update<\/code> command.<\/li>\n<li>Updated the <code>install<\/code> and <code>update<\/code> commands to download the latest hotfix version by default.<\/li>\n<li>Fixed an issue with <code>wp gf form export &lt;form-id&gt;<\/code> where the form ID is ignored.<\/li>\n<\/ul>\n\n<h4>1.0-beta-4<\/h4>\n\n<ul>\n<li>Updated the <code>install<\/code> command to pass the <code>--force<\/code> value to the setup command.<\/li>\n<li>Updated the output when forcing the setup.<\/li>\n<\/ul>\n\n<h4>1.0-beta-3<\/h4>\n\n<ul>\n<li>Added the <code>wp gf setup<\/code> command<\/li>\n<li>Fixed an issue with the <code>install<\/code> command where the database was not setup until visiting the WP dashboard.<\/li>\n<li>Updated the WP-CLI requirement to 1.0+<\/li>\n<\/ul>\n\n<h4>1.0-beta-2<\/h4>\n\n<ul>\n<li>Added support for the WP-CLI package index.<\/li>\n<li>Fixed entry export.<\/li>\n<\/ul>\n\n<h4>1.0-beta-1<\/h4>\n\n<ul>\n<li>All new!<\/li>\n<\/ul>","raw_excerpt":"Manage Gravity Forms on the command line.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/48603","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=48603"}],"author":[{"embeddable":true,"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/rocketgenius"}],"wp:attachment":[{"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=48603"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=48603"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=48603"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=48603"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=48603"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/ug.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=48603"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}