Skip to main content

Settings commands

Commands for reading and writing Burst Statistics plugin options.

save

Updates one or more Burst Statistics plugin options and regenerates the JS config file. This is the CLI equivalent of saving settings in the Burst dashboard.

Usage:

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

At least one option must be provided. Pass true or false as strings for boolean options.

Arguments:

ArgumentTypeRequiredDescription
--<option_name>mixedYesOne or more Burst option names with their new values

Output:

Success: Options saved

The JS config file is regenerated automatically after all options are saved. No cache flush is needed separately.

Examples

Enable cookieless tracking:

wp burst save --enable_cookieless_tracking=one

Set the default analytics view:

wp burst save --analytics_view=dashboard

Enable turbo mode and cookieless tracking in one command:

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

Common option names

The table below lists frequently used options. For the full list, inspect the burst_options database row or use the REST API's GET burst/v1/fields/get endpoint.

Option nameTypeDescription
enable_cookieless_trackingstring (one / '')Enable cookieless tracking mode
enable_turbo_modebool (true / false)Enable turbo (SHORTINIT) tracking
analytics_viewstringDefault dashboard view (dashboard, statistics, etc.)
burst_cookie_expiry_daysintNumber of days before the tracking cookie expires
record_turbo_modeboolRecord hits via the turbo endpoint
ip_anonymizationstringIP anonymisation level
track_logged_in_usersboolWhether to track logged-in WordPress users
disable_cookiebannerboolHide the Burst cookie banner
enable_mainwp_integrationboolAllow the MainWP dashboard to display Burst statistics from child sites

Pro - AgencyAvailable in the Agency tier

enable_mainwp_integration controls the MainWP integration and requires the Agency tier. When set to false, the MainWP proxy is not loaded and child-site statistics are not exposed to the MainWP dashboard.

Using save in deployment scripts

Provision a consistent Burst configuration across environments:

Show code
#!/usr/bin/env bash
set -e

wp burst save \
--enable_cookieless_tracking=one \
--enable_turbo_mode=true \
--track_logged_in_users=false \
--quiet

echo "Burst options configured."

The --quiet flag suppresses the success message, which is useful in CI output where only errors should be visible.

Troubleshooting

Option is saved but the dashboard still shows the old value The JS config file is regenerated by save, but browser caches may hold a stale version. Hard-reload the dashboard (Cmd+Shift+R / Ctrl+Shift+R) or clear the object cache if a caching plugin is active.

Boolean option has no effect after setting to true Some options use string values (one / '') rather than true booleans. Check the current stored value with wp option get burst_options to confirm the expected format.