WP-CLI Commands in Neve

The  neve CLI support provides an interface for performing theme-related operations, such as activating the theme, the license key, it modules from the command line.

First, make sure CLI is installed on your website's server. Here is an article on hosting services that offer CLI pre-installed and how to make sure you have the necessary prerequisite. 

wp neve <action> <license>

Managing the license key

<action>
    Can be activate, deactivate or is-active
<license>
    The license key

Examples

Check whether the license is active; exit status 0 if active, otherwise 1; similar to this core command.

wp neve is-active

Activate the given license key

wp neve activate <license>

Deactivate the given license key

wp neve deactivate <license>


📍Enabling the main modules

Usage

wp neve module activate|deactivate {module name} ?--all

note: --all flag is optional.

Examples:

Enabling All Modules

wp neve module activate --all

Disabling All Modules

wp neve module deactivate --all

Activate the WooCommerce Booster Module

wp neve module activate woocommerce_booster

Activate the WooCommerce Booster, Blog Booster, Scroll to Top ... ... ... Module

wp neve module activate woocommerce_booster blog_pro scroll_to_top

📍Listing main modules

The module returns a list for only the main modules.

Usage

wp neve module list ?--status=active|inactive

Note: —status associative args is optional.

Examples:

Show all main modules with their statuses.

wp neve module list

Show Blog Booster, WooCommerce Booster, Scroll to Top ... ... ... status

wp neve module list blog_pro woocommerce_booster scroll_to_top

List only activated modules

wp neve module list --status=active

List only deactivated modules

wp neve module list --status=inactive
Available Module Command Key
Header Booster hfg_module
WooCommerce Booster woocommerce_booster
TypeKit Fonts typekit_fonts
Performance performance_features
Blog Booster blog_pro
Scroll to Top scroll_to_top
Elementor Booster elementor_booster
White Label white_label
Custom Layouts custom_layouts
LifterLMS Booster lifterlms_booster
Block Editor Booster block_editor_booster

📍Sub Module Options

Usage

The setting keys are unique. The setting key list was defined on the following:

wp neve module setting set {main module slug} {setting key} {setting value}

Examples

Enable Variation Swatches Module

wp neve module setting set woocommerce_booster cart_notices on

Set Theme Name of the White Label

wp neve module setting set white_label theme_name 'My Theme'

Don't Hide Dashboard Options

wp neve module setting set white_label hide_options off

Enter TypeKit Project ID

wp neve module setting set type_kit project_id f2n9u4B0M9y42sbn75F9

Set TypeKit Loading Method

wp neve module setting set type_kit loading_method js

Turning on all the toggles for sub modules

wp neve module setting set woocommerce_booster on --all

Available Setting Keys

Available Module Command Key
WooCommerce Booster
enable_cart_notices
WooCommerce Booster enable_variation_swatches
WooCommerce Booster
enable_custom_thankyou
WooCommerce Booster
enable_comparison_table
TypeKit Fonts typekit_id
TypeKit Fonts typekit_loading_method
Performance enable_emoji_removal
Performance enable_embedded_removal
Performance enable_local_fonts
Performance enable_laxy_content
White Label author_name
White Label author_url
White Label starter_sites
White Label plugin_name
White Label plugin_description
White Label theme_name
White Label theme_description
White Label screenshot_url
White Label white_label
White Label license

📍List Module Settings

The command lists all settings of the specific main module.

Usage

wp neve module setting list {module name}

Examples:

List all settings of the WooCommerce Booster

Command:

wp neve module setting list woocommerce_booster

Output

cart_notices           off
variation_swatches     on
custom_thank_you       off
comparison_table       on

List all settings of the Type Kit Module

Command:

wp neve module setting list type_kit

Output

project_id         f2n9u4B0M9y42sbn75F9
loading_method     javascript

📍Help for Main Modules

Command:

wp help neve module

Expected Output:

  • Should contain all module keys and examples. We should show all module keys such as woocommerce_booster, Typekit, etc. All available module parameters should be shown.

📍Help for Sub Modules

Command:

wp help neve module setting

📍Help for Sub Modules Set Command

Command:

wp help neve module setting set

Expected Output:

  • Should contain all available setting keys
  • Should contain some real examples with real setting keys, such as Don't Hide Dashboard Options: wp neve module setting set white_label hide_dashboard_options off

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us