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>
In this article
Managing the license key
<action>
Can be activate, deactivate or is-active
<license>
The license keyExamples
Check whether the license is active; exit status 0 if active, otherwise 1; similar to this core command.
wp neve is-activeActivate 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} ?--allnote: --all flag is optional.
Examples:
Enabling All Modules
wp neve module activate --allDisabling All Modules
wp neve module deactivate --allActivate the WooCommerce Booster Module
wp neve module activate woocommerce_boosterActivate the WooCommerce Booster and Blog Booster Modules
wp neve module activate woocommerce_booster blog_proListing main modules
The module returns a list for only the main modules.
Usage
wp neve module list ?--status=active|inactiveNote: —status associative args is optional.
Examples:
Show all main modules with their statuses.
wp neve module listShow Blog Booster and WooCommerce Booster status
wp neve module list blog_pro woocommerce_boosterList only activated modules
wp neve module list --status=activeList 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 |
| 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
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 offEnter TypeKit Project ID
wp neve module setting set typekit_fonts project_id f2n9u4B0M9y42sbn75F9Set TypeKit Loading Method
wp neve module setting set typekit_fonts loading_method jsAvailable Setting Keys
| Available Module | Command Key |
|---|---|
| TypeKit Fonts | typekit_id |
| TypeKit Fonts | typekit_loading_method |
| Performance | enable_emoji_removal |
| Performance | enable_embedded_removal |
| Performance | enable_local_fonts |
| Performance | enable_lazy_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 |
| White Label | my_library |
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 TypeKit Fonts Module
Command:
wp neve module setting list typekit_fontsOutput
+-----------+-------------------+---------------------+-----------------------+
| subsetting| key | key_alias | value |
+-----------+-------------------+---------------------+-----------------------+
| | project_id | | f2n9u4B0M9y42sbn75F9 |
| | loading_method | | javascript |
+-----------+-------------------+---------------------+-----------------------+Help for Main Modules
Command:
wp help neve moduleExpected 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 settingHelp for Sub Modules Set Command
Command:
wp help neve module setting setExpected 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_options off
