-
Notifications
You must be signed in to change notification settings - Fork 9
/
readme.txt
245 lines (171 loc) · 8.12 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
=== Gravity Forms CLI Add-On ===
Contributors: rocketgenius
Tags: gravity forms
Requires at least: 4.2
Tested up to: 6.4
Stable tag: 1.5
License: GPL-2.0+
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Manage Gravity Forms on the command line.
== Description ==
The Gravity Forms CLI Add-On allows WP-CLI users to manage forms and entries and more on the command line.
[Documentation](https://docs.gravityforms.com/category/add-ons-gravity-forms/wp-cli-add-on/)
= Getting started =
* `wp help gf`
* `wp help gf form`
* `wp help gf form field`
* `wp help gf form notification`
* `wp help gf entry`
* `wp help gf entry notification`
* `wp help gf install`
* `wp help gf setup`
* `wp help gf license`
* `wp help gf tool`
= Form Management =
`wp gf form [command]`
Commands:
* create - Creates a new form.
* delete - Deletes a form.
* duplicate - Duplicates a form.
* edit - Launch system editor to edit the Form configuration.
* export - Exports forms to a Gravity Forms Form export file.
* form_list - Lists the forms with entry count and view counts.
* get - Returns the form JSON.
* import - Imports forms from a Gravity Forms Form export file.
* update - Updates a form.
= Field Management =
* `wp gf form field [command]`
* `wp gf field [command]` (alias)
Commands:
* create - Creates a field and adds it to a form.
* delete - Deletes a field.
* duplicate - Duplicates a field.
* edit - Launch system editor to edit the Field configuration.
* get - Returns the JSON representation of a field.
* list - Displays a list of fields for a form.
* update - Updates a field.
= Notification Management =
* `wp gf form notification [command]`
* `wp gf notification [command]` (alias)
Commands:
* create - Creates a new notification.
* delete - Deletes a notification.
* duplicate - Duplicates a notification.
* edit - Launch system editor to edit the notification configuration.
* list - Lists the notification.
* get - Returns the notification JSON.
* update - Updates a notification.
= Entry Management =
`wp gf entry [command]`
Commands:
* create - Creates a new entry from either a JSON string with the raw entry or from field-value pairs.
* delete - Deletes an entry.
* duplicate - Duplicates an entry
* edit - Launch system editor to edit the JSON representation of the Entry.
* export - Exports entries.
* get - Returns a JSON representation of an entry.
* import - Imports entries.
* list - Displays a list of entries.
* update - Updates an entry.
= Entry Notifications =
`wp gf entry notification [command]`
Commands:
* get - Returns the notifications for the given entry.
* send - Sends the notifications for the given entry.
= License Management =
`wp gf license [command]`
Commands:
* update - Updates the license key for the installation.
* delete - Deletes the license key for the installation.
= Misc Tools =
`wp gf tool [command]`
Commands:
* clear-transients
* empty-trash Delete the trashed entries.
* verify-checksums Verify Gravity Forms files against the checksums.
* system-report Outputs the system report from the Forms > System Status page. Supports "status" as an alias.
= Installing Gravity Forms and Add-Ons =
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.
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.
A valid license key is required either in the `GF_LICENSE_KEY` constant or the `--key` option.
Examples:
* `wp gf install --key=xxxxx`
* `wp gf install --key=xxxxx --activate`
* `wp gf install gravityformspolls --key=xxxxx`
* `wp gf install gravityformsquiz --key=xxxxx`
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 `--force` flag is set.
Examples:
* `wp gf setup`
* `wp gf setup --force`
Gravity Forms and official add-ons can be updated using the update command.
Examples:
* `wp gf update`
* `wp gf update gravityformspolls`
Check the current version using the version command.
Examples:
* `wp gf version`
* `wp gf version gravityformspolls`
= Requirements =
1. Wordpress 4.2+
2. Gravity Forms 1.9.17.8
3. WP-CLI version 1.0+
= Support =
If you find anything that needs fixing please open a support ticket at https://www.gravityforms.com/open-support-ticket/
If you have any ideas for improvements please submit your idea at https://www.gravityforms.com/gravity-forms-roadmap/
== Installation ==
`wp plugin install gravityformscli --activate`
or
`wp package install https://github.com/gravityforms/gravityformscli.git`
or
1. Download the zipped file.
1. Extract and upload the contents of the folder to /wp-contents/plugins/ folder
1. Go to the Plugin management page of WordPress admin section and enable the 'Gravity Forms CLI' plugin
== ChangeLog ==
= 1.5 =
- Updated the plugin to allow its usage as a WP-CLI package.
= 1.4 =
- Fixed an issue where the version comparison performed when using `wp gf update` with an add-on slug uses the Gravity Forms version number.
- Added support for using `--version=beta` with the `wp gf install` and `wp gf update` commands. Add-On beta releases are not currently supported.
- Fixed a fatal error which can occur when using the `wp gf version` command with an add-on slug when Gravity Forms is not active or not installed.
= 1.3 =
- Fixed an error occurring when using the `wp gf form notification create` command.
= 1.2 =
- Updated Gravity API domain.
- Updated the ids format of the `wp gf entry list` command to support the page-size and offset args. Credit: Ulrich Pogson.
- Updated the form export command to support the optional filename arg e.g. `wp gf form export 1 --filename=testing.json`. Credit: Timothy Decker.
- Fixed an issue where the `wp gf install` command could not network activate plugins.
- Fixed an error occurring when using the `wp gf form notification update` command without the notification-id arg.
- Fixed an issue with the `wp gf entry export` command.
= 1.1 =
- Added support for start_date and end_date filters for the entry export command. e.g. `wp gf entry export 11 --start_date="2018-11-01" --end_date="2018-11-11"`
- Added the `wp gf tool system-report` command and the `wp gf tool status` alias for outputting the system report from the Gravity Forms 2.2+ System Status page.
- Fixed an issue with the `wp gf install` command ending with an error message when no error occurred.
- Fixed an issue where old messages could continue to be displayed in the admin following a license key change.
- Fixed an "invalid synopsis part" warning and an "unknown parameter" error with the `wp gf form field update` command.
- Fixed the `wp gf form update` command using the wrong argument to get the existing form which could result in a form not found error.
- Fixed an issue with the `wp gf form create` command where missing field IDs are added automatically.
= 1.0 =
- Added the `wp gf license` command.
- Fixed an issue with updating forms from an export file.
= 1.0-rc-1 =
- Added the `--file` arg to the `wp gf form update` command to allow forms to be updated from an export file.
- Fixed a fatal error when using the install command.
= 1.0-beta-5 =
- Added the `wp gf form notification` command.
- Added the `wp gf entry notification` command.
- Added the `wp gf version` command.
- Added the `wp gf update` command.
- Updated the `install` and `update` commands to download the latest hotfix version by default.
- Fixed an issue with `wp gf form export <form-id>` where the form ID is ignored.
= 1.0-beta-4 =
- Updated the `install` command to pass the `--force` value to the setup command.
- Updated the output when forcing the setup.
= 1.0-beta-3 =
- Added the `wp gf setup` command
- Fixed an issue with the `install` command where the database was not setup until visiting the WP dashboard.
- Updated the WP-CLI requirement to 1.0+
= 1.0-beta-2 =
- Added support for the WP-CLI package index.
- Fixed entry export.
= 1.0-beta-1 =
- All new!