otty / apps

All apps/WP-CLI

WP-CLI

The command line for WordPress. No browser required.

Runs as wp|macOS, Linux, Windows|wp-cli.org

Open form in Otty otty.toml

Sync rules

What travels, what stays, what never leaves

WP-CLI in your home directory Every rule on this page, by file

pathrequire

Each machine keeps its own copy of these.

config create.dbpasscore config.dbpass

Lifted into your secret store; the rest of the file syncs.

· cache/ Exclude

· packages/ Exclude

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/wp/otty.tomlThe file this page is generated from

id = "wp"

name = "WP-CLI"

homepage = "https://wp-cli.org"

description = "The command line for WordPress. No browser required."

icon = "SimpleIcons:wordpress"

executables = ["wp"]

[dotfiles]

# https://make.wordpress.org/cli/handbook/references/config/ — the per-user

# global config is ~/.wp-cli/config.yml, overridable with WP_CLI_CONFIG_PATH.

# The other two files WP-CLI reads, wp-cli.local.yml and wp-cli.yml, are found

# in the current directory or upwards, so they belong to a project, not a user.

paths = ["~/.wp-cli/config.yml"]

# Same page: WP_CLI_CACHE_DIR defaults to ~/.wp-cli/cache and

# WP_CLI_PACKAGES_DIR to ~/.wp-cli/packages, which is a Composer checkout of

# the community packages — downloaded state, not config.

exclude = ["~/.wp-cli/cache/", "~/.wp-cli/packages/"]

secret = []

# A one-shot PHP process that reads the file at startup and exits.

side_effect = false

# `path` is where the WordPress install sits on this disk and `require` names

# PHP files loaded from it — both are absolute locations on this machine. The

# rest of the file (url, user, color, disabled_commands, aliases) is a

# preference the user wants everywhere.

# Both name the user's own install on this disk, which is what they would want

# back when rebuilding the machine, so they are kept for this device alone.

[[dotfiles.machine_lines]]

file = "~/.wp-cli/config.yml"

match = { key_path = ["path", "require"] }

scope = "backup"

# The handbook's own example config sets database credentials as subcommand

# defaults. `wp core config` was renamed `wp config create` in WP-CLI 1.5 and

# the old spelling still parses, so both section names are listed — a config

# written before the rename carries the password under the other key.

[[dotfiles.secret_paths]]

file = "~/.wp-cli/config.yml"

match = { key_path = ["config create.dbpass", "core config.dbpass"] }

[commands]

format = 1

label = "WP-CLI"

description = "Manage plugins and run database search-replace for a WordPress site. Run from the site directory or set the WordPress path. Other command groups are left out."

quality = "ai-draft"

base = "fig:wp"

parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/wp.ts"

license = "MIT"

[[commands.subcommand]]

path = ["plugin", "list"]

label = "List plugins"

description = "Show installed plugins."

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/wp.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "status"

label = "Status"

type = "string"

option = ["--status"]

value_style = "equals"

suggestions = [{ value = "active", label = "active" }, { value = "inactive", label = "inactive" }, { value = "must-use", label = "must-use" }, { value = "dropin", label = "dropin" }, { value = "active-network", label = "active-network" }]

sources = ["fig"]

[[commands.subcommand.field]]

id = "format"

label = "Output format"

type = "string"

option = ["--format"]

value_style = "equals"

suggestions = [{ value = "table", label = "table" }, { value = "csv", label = "csv" }, { value = "json", label = "json" }, { value = "count", label = "count" }, { value = "yaml", label = "yaml" }]

sources = ["fig"]

[[commands.subcommand.field]]

id = "field"

label = "Single field"

type = "string"

option = ["--field"]

value_style = "equals"

sources = ["fig"]

[[commands.subcommand.field]]

id = "fields"

label = "Fields"

description = "Comma-separated list of fields."

type = "string"

option = ["--fields"]

value_style = "equals"

sources = ["fig"]

[[commands.subcommand.task]]

id = "list"

label = "List plugins"

fields = ["status", "format"]

[[commands.subcommand.task]]

id = "active"

label = "Active plugins"

fields = ["status", "format"]

set = { status = ["active"] }

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["status", "format"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["field", "fields"]

[[commands.subcommand]]

path = ["plugin", "install"]

label = "Install plugins"

description = "Install from wordpress.org, a zip or a URL."

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/wp.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "plugin"

label = "Plugin slug, zip or URL"

type = "string"

position = 0

multiple = true

sources = ["fig"]

[[commands.subcommand.field]]

id = "version"

label = "Version"

type = "string"

option = ["--version"]

value_style = "equals"

sources = ["fig"]

[[commands.subcommand.field]]

id = "force"

label = "Overwrite installed version"

type = "boolean"

option = ["--force"]

effect = "overwrite"

sources = ["fig"]

[[commands.subcommand.field]]

id = "activate"

label = "Activate after install"

type = "boolean"

option = ["--activate"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "install"

label = "Install and activate"

fields = ["plugin", "activate"]

required = ["plugin"]

set = { activate = [true] }

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["plugin", "activate"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["version", "force"]

[[commands.subcommand]]

path = ["plugin", "activate"]

label = "Activate plugins"

description = "Activate one or all plugins."

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/wp.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "plugin"

label = "Plugins"

type = "string"

position = 0

multiple = true

sources = ["fig"]

[[commands.subcommand.field]]

id = "all"

label = "All plugins"

type = "boolean"

option = ["--all"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "network"

label = "Network-wide"

type = "boolean"

option = ["--network"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "activate"

label = "Activate plugin"

fields = ["plugin"]

required = ["plugin"]

[[commands.subcommand.task]]

id = "all"

label = "Activate all"

fields = ["all"]

set = { all = [true] }

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["plugin", "all"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["network"]

[[commands.subcommand]]

path = ["search-replace"]

label = "Search and replace"

description = "Replace strings in the database. Preview with a dry run first."

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/wp.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "old"

label = "Search for"

type = "string"

position = 0

sources = ["fig"]

[[commands.subcommand.field]]

id = "new"

label = "Replace with"

type = "string"

position = 1

sources = ["fig"]

[[commands.subcommand.field]]

id = "table"

label = "Tables"

description = "Restrict to these tables; wildcards allowed."

type = "string"

position = 2

multiple = true

sources = ["fig"]

[[commands.subcommand.field]]

id = "dry_run"

label = "Dry run"

type = "boolean"

option = ["--dry-run"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "all_tables"

label = "All tables"

type = "boolean"

option = ["--all-tables"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "skip_tables"

label = "Skip tables"

description = "Comma-separated list."

type = "string"

option = ["--skip-tables"]

value_style = "equals"

sources = ["fig"]

[[commands.subcommand.field]]

id = "skip_columns"

label = "Skip columns"

description = "Comma-separated list."

type = "string"

option = ["--skip-columns"]

value_style = "equals"

sources = ["fig"]

[[commands.subcommand.field]]

id = "regex"

label = "Treat as regex"

type = "boolean"

option = ["--regex"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "precise"

label = "Use PHP for thorough replacement"

type = "boolean"

option = ["--precise"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "export"

label = "Export to SQL file instead"

type = "path"

option = ["--export"]

path = { kind = "file", role = "output" }

value_style = "equals"

effect = "overwrite"

sources = ["fig"]

[[commands.subcommand.field]]

id = "path"

label = "WordPress path"

type = "path"

option = ["--path"]

path = { kind = "directory", role = "input" }

value_style = "equals"

sources = ["fig"]

[[commands.subcommand.task]]

id = "dry"

label = "Preview replacement"

fields = ["old", "new", "table", "dry_run"]

required = ["old", "new"]

set = { dry_run = [true] }

[[commands.subcommand.task]]

id = "run"

label = "Run replacement"

fields = ["old", "new", "table"]

required = ["old", "new"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["old", "new", "table", "dry_run"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["all_tables", "skip_tables", "skip_columns", "regex", "precise", "export", "path"]

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/wp. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits path and require for you — that part is Otty’s own sync, or a template you write by hand.