Skip to content

Commit b3bc99d

Browse files
authored
Merge pull request #479 from jazzsequence/cli-command-docs
Add a WP-CLI commands section to the readme
2 parents 02ac1d8 + aa41d27 commit b3bc99d

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,34 @@ registration is enabled, it will also give a link to the registration page.
203203
`[bigcommerce_shipping_address_list]` - A list of the customer's shipping addresses, and
204204
forms to add, remove, or update addresses.
205205

206+
## WP-CLI Commands
207+
208+
The BigCommerce for WordPress plugin includes several WP-CLI commands to help manage your store and work with products. All of the commands are subcommands of `bigcommerce`.
209+
210+
### `bigcommerce countries update`
211+
212+
Update the cache of countries and states in `countries.json`.
213+
214+
### `bigcommerce docs build <file>`
215+
216+
Builds plugin documentation. `<file>` refers to a specific JSON file in the WordPress install to export the documentation to. Requires [WP Parser](https://github.com/WordPress/phpdoc-parser) to build documentation.
217+
218+
### `bigcommerce docs import <file>>`
219+
220+
Imports plugin documentation from a JSON file (`<file>`).
221+
222+
### `bigcommerce import products`
223+
224+
Imports products from the connected BigCommerce store.
225+
226+
### `bigcommerce resources build <file> [--pretty]`
227+
228+
Builds plugin resources JSON from a CSV file. `<file>` refers to the CSV file with resource data to import. The `--pretty` flag will format the JSON output for readability.
229+
230+
### `bigcommerce dev reset-plugin`
231+
232+
Resets the database options for the plugin to bring you back to the beginning of the account onboarding flow. Primarily used for development purposes. **Note:** This command does not delete any products that may have been imported from your BigCommerce store.
233+
206234
## Template Overrides
207235

208236
All templates that render on the front end are found in the `templates/public` directory. To

0 commit comments

Comments
 (0)