WP-CLI Commands

Burst Statistics registers a burst command group with WP-CLI. All commands follow the standard WP-CLI pattern:

wp burst <command> [<args>] [--<assoc_arg>=<value> ...]

---

Commands

add_goal

Add a new conversion goal by passing goal properties as associative arguments.

Usage:

wp burst add_goal --<property>=<value> [--<property>=<value> ...]

Arguments:

Argument	Type	Required	Description
--<property>	mixed	Yes	One or more Goal object properties to set (e.g. --title, --type, --url). At least one property must be provided.

Example:

wp burst add_goal --title="Purchase" --type="page_visit" --url="/thank-you"

---

save

Update one or more Burst Statistics plugin options and regenerate the JS config file.

Usage:

wp burst save --<option_name>=<value> [--<option_name>=<value> ...]

Arguments:

Argument	Type	Required	Description
--<option_name>	mixed	Yes	One or more option names with their new values. Pass true as a string to store a boolean true. At least one option must be provided.

Example:

wp burst save --enable_turbo_mode=true --enable_cookieless_tracking=one

wp burst save --analytics_view=dashboard

The JS config file is regenerated automatically after all options are saved.

---

install_demo_data

Populate the database with demo statistics data for testing or demonstration purposes.

Usage:

wp burst install_demo_data

Example:

wp burst install_demo_data
# Success: Demo data installed

---

reset_data

Delete all Burst Statistics data and reset the plugin to its default state.

caution

This action is irreversible. All collected analytics data will be permanently deleted.

Usage:

wp burst reset_data

Example:

wp burst reset_data
# Success: Data reset

---

activate_license

Activate a Burst Statistics Pro license key.

⭐ Pro

This command requires Burst Statistics Pro to be installed. Upgrade to Burst Pro

Usage:

wp burst activate_license <license_key>

Arguments:

Argument	Type	Required	Description
<license_key>	string	Yes	The license key to activate.

Example:

wp burst activate_license XXXX-XXXX-XXXX-XXXX
# Success: License activated

---

deactivate_license

Deactivate a Burst Statistics Pro license key.

⭐ Pro

This command requires Burst Statistics Pro to be installed. Upgrade to Burst Pro

Usage:

wp burst deactivate_license <license_key>

Arguments:

Argument	Type	Required	Description
<license_key>	string	Yes	The license key to deactivate.

Example:

wp burst deactivate_license XXXX-XXXX-XXXX-XXXX
# Success: License activated

---

unzip

Extract a ZIP archive to a specified directory using the WordPress Filesystem API.

Usage:

wp burst unzip --zip_path=<path> --extract_to=<path>

Arguments:

Argument	Type	Required	Description
--zip_path	string	Yes	Absolute path to the ZIP file to extract.
--extract_to	string	Yes	Absolute path to the directory to extract into. The directory is created if it does not exist.

Example:

wp burst unzip --zip_path=/tmp/burst-data.zip --extract_to=/var/www/html/wp-content/uploads/burst
# Success: Extracted /tmp/burst-data.zip to /var/www/html/wp-content/uploads/burst

---

send_test_telemetry

Send a test telemetry payload to the Burst Statistics data-sharing endpoint. Useful for verifying that the telemetry pipeline is working correctly.

caution

This command is restricted to test environments (WP_ENV=test or equivalent) or sites where the constant BURST_ALLOW_TEST_TELEMETRY is defined in wp-config.php. It will return an error on standard production sites.

Usage:

wp burst send_test_telemetry [--endpoint=<url>]

Arguments:

Argument	Type	Required	Description
--endpoint	string	No	A custom endpoint URL to send the telemetry payload to. Defaults to the built-in Burst Statistics telemetry endpoint.

Example — default endpoint:

wp burst send_test_telemetry
# Sending test telemetry to default endpoint
# { ... }
# Success: Test telemetry sent successfully

Example — custom endpoint:

wp burst send_test_telemetry --endpoint=https://example.com/telemetry
# Sending test telemetry to custom endpoint: https://example.com/telemetry
# { ... }
# Success: Test telemetry sent successfully

To enable this command outside a test environment, add the following to wp-config.php:

define( 'BURST_ALLOW_TEST_TELEMETRY', true );

---

get_internal_links

Scan the plugin's PHP source files and output a JSON array of all internal admin URLs and anchor targets found in the code.

caution

This command is restricted to test environments and will silently exit on production sites.

Usage:

wp burst get_internal_links

Example:

wp burst get_internal_links
# [
#   "#/dashboard",
#   "#/settings/tracking",
#   ...
# ]