Minn\Cli

The updater for one kind of asset, with the runtime up.

Updates the named assets, or all of them.

Flushes the object cache.

The engine does not run an object cache. The verb still succeeds so fleet scripts that call it after a write do not abort.

Registers every engine verb with WP-CLI in the phase it runs in.

Says whether WordPress core is up to date; on Minn it always is, and an asked-for version or package is refused.

## OPTIONS

[<zip>] : A WordPress package; refused on Minn.

[--minor] : Only a minor release.

[--version=<version>] : A WordPress version; refused on Minn.

[--force] : Refused on Minn.

[--locale=<locale>] : Ignored.

[--insecure] : Ignored.

Checks the install's files against its signed Minn release, in WP-CLI's own words for the result.

## OPTIONS

[--include-root] : Ignored; the webroot's shape files are always checked.

[--version=<version>] : Ignored; the running Minn's release is the one checked.

[--locale=<locale>] : Ignored.

[--insecure] : Ignored.

[--exclude=<files>] : Comma-separated paths to leave out of the result.

Holds back `core download` over a Minn install unless MINN_ALLOW_CORE_DOWNLOAD is set; `wp minn eject` is the way back to WordPress.

Lists the scheduled cron events.

## OPTIONS

[--hook=<name>] [--field=<field>] [--fields=<fields>] [--format=<format>] [--<field>=<value>] [--due-now]

Runs the next scheduled cron event for the given hook.

## OPTIONS

[<hook>...] [--due-now] [--all]

Schedules a new cron event.

## OPTIONS

<hook> [<next-run>] [<recurrence>] [--<field>=<value>]

Deletes all cron events for the given hook.

## OPTIONS

<hook>...

Unschedules all cron events for a given hook.

## OPTIONS

<hook>

Lists available cron schedules.

## OPTIONS

[--field=<field>] [--fields=<fields>] [--format=<format>]

Tests the WP Cron spawning system and reports the results.

Searches the directory (through the Minn update service) for one kind of asset and prints the page.

The bin entry: runs one command against a webroot and returns the exit code.

What the site will and will not get; the worst light decides install. The report lands in the output.

Replaces this engine with the latest release from the Minn update service; --check only says whether there is one.

Prints what the webroot is running.

Installs the engine into a webroot when the preflight allows it.

Puts WordPress back and removes the engine's files.

What a webroot is running: minn, wordpress, or unknown.

The install record for a webroot: its owner, when, the engine version, the park, what moved, what was laid down. Empty when there is none, or when the one found names another webroot (a site that was moved or copied keeps a record its own eject must not act on).

Activates maintenance mode.

Deactivates maintenance mode.

Displays maintenance mode status.

Detects maintenance mode status. Exit 0 when active, 1 when not.

Prints the engine version.

Prints the inventory CaptainCore gathers from inside WordPress: plugins, themes, must-use plugins, core version, home. One `key:value` line per field; JSON values have no newlines. Split on the first colon only.

Prints the engine's version and where it runs from.

Runs the engine's scheduled work: due posts go live, expired rows are swept.

Sends a test email through the site's mail settings.

## OPTIONS

<to> : The address to send to.

Says what a WordPress webroot will and will not get from the engine.

## OPTIONS

[<webroot>] : The webroot to inspect. Defaults to the current directory.

Parks WordPress and installs the engine into a webroot.

## OPTIONS

[<webroot>] : The webroot. Defaults to the current directory.

[--park=<dir>] : Where WordPress's own files go. Defaults to wp-parked beside the webroot.

[--force] : Install even when preflight is RED.

Replaces this engine with the latest Minn release from the update service, checked against its signature.

## OPTIONS

[--check] : Only say whether a newer release is out.

Removes the engine and puts WordPress's files back.

## OPTIONS

[<webroot>] : The webroot. Defaults to the current directory.

Says whether a webroot runs WordPress or the engine.

## OPTIONS

[<webroot>] : The webroot. Defaults to the current directory.

The site's script pack: the GPL `wp-*` JavaScript packages the engine does not reimplement, which a few plugin front ends need (the WooCommerce block cart and checkout). The engine never ships them; this installs them into the site's own wp-content, from the WordPress the swap parked beside the webroot, or from any WordPress tree named with --from.

## OPTIONS

[<action>] : status (the default), install, or remove.

[--from=<path>] : A WordPress tree to take the packages from. Defaults to the parked copy the install recorded.

The extensions recovery paused after they killed a request, and the way back. A plugin or theme that fatals is paused so the next request answers without it; nothing loads it again until it is resumed here.

## OPTIONS

[<action>] : status (the default), resume, or resume-all.

[<name>] : For resume: the plugin file or theme slug to let back in.

[--theme] : Treat the name as a theme rather than a plugin.

Gets the value for an option.

## OPTIONS

<key> : Key for the option.

[--format=<format>] : Get value in a particular format. --- default: var_export options: - var_export - json - yaml ---

Adds a new option value.

## OPTIONS

<key> : The name of the option to add.

[<value>] : The value of the option to add. If omitted, the value is read from STDIN.

[--format=<format>] : The serialization format for the value. --- default: plaintext options: - plaintext - json ---

[--autoload=<autoload>] : Should this option be automatically loaded. --- options: - 'on' - 'off' ---

Updates an option value.

## OPTIONS

<key> : The name of the option to update.

[<value>] : The new value. If omitted, the value is read from STDIN.

[--autoload=<autoload>] : Requires WP 4.2. Should this option be automatically loaded. --- options: - 'on' - 'off' ---

[--format=<format>] : The serialization format for the value. --- default: plaintext options: - plaintext - json ---

Deletes an option.

## OPTIONS

<key>... : Key for the option.

The installer `wp theme install` uses.

The installer `wp plugin install` uses.

One source onto disk: the folder when it is there afterwards (put there now, or already there), null when it could not be installed, and whether this call put it there.

Lists installed plugins, must-use plugins, and drop-ins.

## OPTIONS

[--status=<status>] : Filter to one status: active, inactive, must-use, or dropin.

[--field=<field>] : Prints the value of a single field for each plugin.

[--fields=<fields>] : Limit the output to specific object fields.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - json - count - yaml ---

Activates one or more plugins: a WordPress plugin joins active_plugins (its stored state; the engine runs none of its code), a Minn extension joins the engine's own list.

## OPTIONS

<plugin>... : One or more plugins to activate.

Deactivates one or more plugins.

## OPTIONS

<plugin>... : One or more plugins to deactivate.

Installs one or more plugins from the plugin directory, a zip, or a URL.

## OPTIONS

<plugin|zip|url>... : A plugin slug, a local zip path, or a zip URL.

[--version=<version>] : Install that version from the directory instead of the current one.

[--force] : Overwrite an installed copy of the same folder.

[--activate] : Activate the plugin after it is installed (or if it is already on disk).

Updates one or more plugins from the plugin directory.

## OPTIONS

[<plugin>...] : One or more plugins to update.

[--all] : If set, all plugins that have updates will be updated.

[--exclude=<name>] : Comma separated list of plugin names that should be excluded from updating.

[--minor] : Only perform updates for minor releases.

[--patch] : Only perform updates for patch releases.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - json - summary ---

[--version=<version>] : If set, the plugin will be updated to the specified version.

[--dry-run] : Preview which plugins would be updated.

Deletes plugin files without deactivating.

## OPTIONS

[<plugin>...] : One or more plugin folders to delete.

Checks if a given plugin is installed. Exit 0 when it is, 1 when not.

## OPTIONS

<plugin> : The plugin folder to check.

Checks if a given plugin is active. Exit 0 when it is, 1 when not.

## OPTIONS

<plugin> : The plugin folder to check.

[--network] : Ignored on a single site.

Searches the plugin directory.

## OPTIONS

<search> : The string to search for.

[--page=<page>] : Optional page to display. --- default: 1 ---

[--per-page=<per-page>] : Optional number of results to display. --- default: 10 ---

[--field=<field>] : Prints the value of a single field for each plugin.

[--fields=<fields>] : Limit the output to specific object fields. Defaults to name,slug,rating.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - json - count - yaml ---

The report, one line per finding. @return list<string>

Runs every check and returns the worst light: GREEN, AMBER, or RED.

Same line Theme::active / ClassicTheme::active draw: a block template index (child or parent) is a block theme; otherwise a parent index.php is a classic theme.

Flushes rewrite rules. The engine resolves URLs from options, so this is a success no-op the way `cache flush` is.

## OPTIONS

[--hard] : Ignored: the engine does not write .htaccess.

Updates the permalink structure.

## OPTIONS

<permastruct> : The new permalink structure, stored as permalink_structure.

[--category-base=<base>] : Stored as category_base.

[--tag-base=<base>] : Stored as tag_base.

[--hard] : Ignored: the engine does not write .htaccess.

The engine's runtime for a CLI process, booted once.

The full WordPress runtime for a command, booted once: the facade is defined, the site's plugins load as code, and the lifecycle actions fire, so a verb can fire a scheduled hook whose callback a plugin registered. The lighter boot() does none of this; only a command that needs the runtime (cron) asks for this, since it loads every plugin.

The runtime for a command WP-CLI loads WordPress for: WP-CLI has already run wp-config.php, so the engine boots from the constants it defined, loads the site's plugins as code (their commands register as they load), and hands control back for WP-CLI to run the command.

Searches/replaces strings in the database.

## OPTIONS

<old> : A string to search for.

<new> : Replace instances of the first string with this new string.

[<table>...] : Restrict the replacement to these tables.

[--dry-run] : Report without writing.

[--all-tables] : Search every table in the database, not only those with the site prefix.

[--report-changed-only] : Only print tables/columns that changed.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - json ---

Lists installed themes.

## OPTIONS

[--status=<status>] : Filter to one status: active, inactive, or parent.

[--field=<field>] : Prints the value of a single field for each theme.

[--fields=<fields>] : Limit the output to specific object fields.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - json - count - yaml ---

Installs one or more themes from the theme directory, a zip, or a URL.

## OPTIONS

<theme|zip|url>... : A theme slug, a local zip path, or a zip URL.

[--version=<version>] : Install that version from the directory instead of the current one.

[--force] : Overwrite an installed copy of the same folder.

[--activate] : Activate the theme after it is installed (or if it is already on disk).

Updates one or more themes from the theme directory.

## OPTIONS

[<theme>...] : One or more themes to update.

[--all] : If set, all themes that have updates will be updated.

[--exclude=<theme-names>] : Comma separated list of theme names that should be excluded from updating.

[--minor] : Only perform updates for minor releases.

[--patch] : Only perform updates for patch releases.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - json - summary ---

[--version=<version>] : If set, the theme will be updated to the specified version.

[--dry-run] : Preview which themes would be updated.

Activates a theme.

## OPTIONS

<theme> : The theme folder to activate.

Deletes one or more themes from disk.

## OPTIONS

[<theme>...] : One or more theme folders to delete.

[--force] : Allow deleting the active theme.

Checks if a given theme is installed. Exit 0 when it is, 1 when not.

## OPTIONS

<theme> : The theme folder to check.

Checks if a given theme is active. Exit 0 when it is, 1 when not.

## OPTIONS

<theme> : The theme folder to check.

Searches the theme directory.

## OPTIONS

<search> : The string to search for.

[--page=<page>] : Optional page to display. --- default: 1 ---

[--per-page=<per-page>] : Optional number of results to display. Defaults to 10.

[--field=<field>] : Prints the value of a single field for each theme.

[--fields=<fields>] : Limit the output to specific object fields. Defaults to name,slug,rating.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - json - count - yaml ---

Lists users.

## OPTIONS

[--role=<role>] : Only display users with a certain role.

[--field=<field>] : Prints the value of a single field for each user.

[--fields=<fields>] : Limit the output to specific object fields.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - ids - json - count - yaml ---

Gets details about a user.

## OPTIONS

<user> : User ID, user email, or user login.

[--field=<field>] : Instead of returning the whole user, returns the value of a single field.

[--fields=<fields>] : Get a specific subset of the user's fields.

[--format=<format>] : Render output in a particular format. --- default: table options: - table - csv - json - yaml ---

Prints a one-time login link for a user.

The link signs the user in at wp-login.php once, within fifteen minutes, and then expires (the contract of the captaincore helper).

## OPTIONS

<user> : User ID, user email, or user login.

Creates a new user.

## OPTIONS

<user-login> : The login of the user to create.

<user-email> : The email address of the user to create.

[--role=<role>] : The role of the user to create. Default: the site's default role.

[--user_pass=<password>] : The user password. Default: randomly generated.

[--display_name=<name>] : The display name.

[--user_nicename=<nice_name>] : A URL-friendly name. Default: the login.

[--user_url=<url>] : The user's URL.

[--nickname=<nickname>] : The nickname. Default: the login.

[--first_name=<first_name>] : The first name.

[--last_name=<last_name>] : The last name.

[--description=<description>] : A description.

[--send-email] : Send the new user a password-reset email.

[--porcelain] : Output just the new user id.

Updates an existing user.

## OPTIONS

<user> : User ID, email, or login.

[--user_pass=<password>] : A new password.

[--user_email=<email>] : A new email.

[--display_name=<name>] : A new display name.

[--first_name=<first_name>] : A new first name.

[--last_name=<last_name>] : A new last name.

[--role=<role>] : A new role.

Deletes a user.

## OPTIONS

<user> : User ID, email, or login.

[--reassign=<id>] : User ID to reassign posts to.

[--yes] : Answer yes to the confirmation.