WordPress

Comandos de la CLI de WordPress

Consulta todos los comandos, opciones y códigos de salida de la CLI de WordPress.

Busca cualquier comando de wordpress, sus opciones y sus códigos de salida, con la seguridad de que coinciden con tu versión: esta página se genera a partir del propio programa. Para la misma lista en JSON, ejecuta wordpress commands --json. Las descripciones conservan el idioma de la ayuda.

La primera palabra es el perfil, un nombre que eliges tú: wordpress personal config show. WCWP_PROFILE hace lo mismo para toda una sesión de la terminal. Nunca se da un perfil por supuesto: un comando que usa una cuenta se detiene si no lo tiene y muestra los perfiles de este ordenador.

Opciones para todos los comandos

OptionWhat it does
-V, --versionoutput the version number.
-v, --verbosemore detail in what is shown: -v ids, -vv everything we know. Default: 0.
--jsonmachine-readable output: one JSON value on stdout; --json=id,text keeps only those fields.
--jsonlmachine-readable output: one JSON object per line, for streaming and jq.
--quietdiagnostics off; a failure is still said.
--tracethe connection's own log lines on stderr — never content.
--debugon a failure, its whole record — cause and stack — in place of the short line.
--timeout <duration>give up on the whole command after this — 30s, 2m, 500ms.
--offlineanswer from what was recorded and never connect; fails if nothing was.
--no-inputnever prompt or open interactive login; piped input remains available.
--max-input-bytes <bytes>maximum buffered input bytes (default: 16777216).
--max-output-bytes <bytes>maximum machine output bytes (default: 4194304; 0 disables).
--brieffound items as reference, title, time, author and excerpt only.
--fullfound items with their whole text and every provider field.
--compactone line per item for an agent: reference first, text last, paging and next steps as # lines.
--dry-runpreview parsed arguments and permissions before running the action.
--yesgo ahead without the question an ask level puts before a write.
--recordkeep this run even where the config says record false; record_input false leaves the typed words out.
--no-recorddo not keep this run, even if it fails.

wordpress commands

every command by section; --json prints its contract, one path per call

wordpress commands info

one command contract, or all schemas, error reasons and explicit overrides

wordpress commands info [path]
ArgumentObligatoriedadWhat it is
pathoptionalone command path; without one, export schemas, error reasons and explicit overrides.

Example: wordpress commands info commands

wordpress session

keep this profile's WordPress token in the OS keyring

wordpress session start

sign this profile in: the WordPress application password is asked hidden or read from stdin, never taken as an argument, checked with WordPress, and only then kept in the keyring, or in a private file. Make an application password in your WordPress profile; it can do what your user can, no more.

Changes something on this computer only.

wordpress session start [options]
OptionWhat it does
--credential-storage <storage>where the token is kept: keyring, which falls back to a private file by itself, or file. Default: keyring.
--login <name>the WordPress user name the password belongs to.
--site <address>the WordPress site, as https://blog.example.com or blog.example.com.

Example: wordpress personal session start --site blog.example.com --login <name>, wordpress personal session start --credential-storage file

wordpress session status

show where this profile's token comes from: WCWP_TOKEN, the keyring or a file, never the token; --check asks WordPress whose token it is

wordpress session status [options]
OptionWhat it does
--checkask WordPress whether the token still works, and whose it is.

Example: wordpress personal session status, wordpress personal session status --check --json

wordpress session end

forget this profile's token on this computer; the token itself stays valid in WordPress

Changes something on this computer only.

wordpress session end

Example: wordpress personal session end

wordpress session list

list the profiles on this computer and whether each has a token; picks none

wordpress session list

Example: wordpress session list, wordpress session list --json

wordpress api

the raw WordPress API, one command per operation of its OpenAPI document

wordpress api list

list every WordPress API operation this CLI offers, without calling WordPress

wordpress api list [query]
ArgumentObligatoriedadWhat it is
queryoptionalfield:value terms that narrow the list — the fields are below.

Example: wordpress personal api list, wordpress personal api list effect:destructive --json=command,path

wordpress api show

show one operation's parameters and request schema, without calling WordPress

wordpress api show <operation>
ArgumentObligatoriedadWhat it is
operationrequiredthe operation as api list prints it (quoted), its old name, or its operation id.

Example: wordpress personal api show "block-directory-search-list" --json

wordpress api block-directory-search-list

getWpV2BlockDirectorySearch — read (GET /wp/v2/block-directory/search)

wordpress api block-directory-search-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--term <value>Limit result set to blocks matching the search term.
--allread every page, as the API pages it.

Example: wordpress personal api block-directory-search-list --term <value>

wordpress api block-patterns-categories-list

getWpV2BlockPatternsCategories — read (GET /wp/v2/block-patterns/categories)

wordpress api block-patterns-categories-list

Example: wordpress personal api block-patterns-categories-list

wordpress api block-patterns-patterns-list

getWpV2BlockPatternsPatterns — read (GET /wp/v2/block-patterns/patterns)

wordpress api block-patterns-patterns-list

Example: wordpress personal api block-patterns-patterns-list

wordpress api block-types-list

getWpV2BlockTypes — read (GET /wp/v2/block-types)

wordpress api block-types-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--namespace <value>Block namespace.

Example: wordpress personal api block-types-list

wordpress api block-types-list-namespace

getWpV2BlockTypesByNamespace — read (GET /wp/v2/block-types/{namespace})

wordpress api block-types-list-namespace [options]
OptionWhat it does
--namespace <value>namespace.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api block-types-list-namespace --namespace <value>

wordpress api block-types-get

getWpV2BlockTypesByNamespaceByName — read (GET /wp/v2/block-types/{namespace}/{name})

wordpress api block-types-get [options]
OptionWhat it does
--namespace <value>namespace.
--name <value>name.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api block-types-get --namespace <value> --name <value>

wordpress api blocks-list

getWpV2Blocks — read (GET /wp/v2/blocks)

wordpress api blocks-list [options]
OptionWhat it does
--after <value>Limit response to posts published after a given ISO8601 compliant date.
--before <value>Limit response to posts published before a given ISO8601 compliant date.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--modified-after <value>Limit response to posts modified after a given ISO8601 compliant date.
--modified-before <value>Limit response to posts modified before a given ISO8601 compliant date.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--search-columns <value>Array of column names to be searched.
--search-semantics <value>How to interpret the search input.
--slug <value>Limit result set to posts with one or more specific slugs.
--status <value>Limit result set to posts assigned one or more statuses.
--tax-relation <value>Limit result set based on relationship between multiple taxonomies.
--wp-pattern-category <value>Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.
--wp-pattern-category-exclude <value>Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy.
--allread every page, as the API pages it.

Example: wordpress personal api blocks-list

wordpress api blocks-create

postWpV2Blocks — write (POST /wp/v2/blocks)

Changes something in the service.

wordpress api blocks-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api blocks-create

wordpress api blocks-get

getWpV2BlocksById — read (GET /wp/v2/blocks/{id})

wordpress api blocks-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--excerpt-length <value>Override the default excerpt length.
--password <value>The password for the post if it is password protected.

Example: wordpress personal api blocks-get --id <value>

wordpress api blocks-update

postWpV2BlocksById — write (POST /wp/v2/blocks/{id})

Changes something in the service.

wordpress api blocks-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api blocks-update --id <value>

wordpress api blocks-delete

deleteWpV2BlocksById — destructive (DELETE /wp/v2/blocks/{id})

Changes something in the service.

wordpress api blocks-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api blocks-delete --id <value>

wordpress api blocks-autosaves-list

getWpV2BlocksByIdAutosaves — read (GET /wp/v2/blocks/{id}/autosaves)

wordpress api blocks-autosaves-list [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--parent <value>The ID for the parent of the autosave.

Example: wordpress personal api blocks-autosaves-list --id <value>

wordpress api blocks-autosaves-create

postWpV2BlocksByIdAutosaves — write (POST /wp/v2/blocks/{id}/autosaves)

Changes something in the service.

wordpress api blocks-autosaves-create [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api blocks-autosaves-create --id <value>

wordpress api blocks-autosaves-get

getWpV2BlocksByParentAutosavesById — read (GET /wp/v2/blocks/{parent}/autosaves/{id})

wordpress api blocks-autosaves-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api blocks-autosaves-get --parent <value> --id <value>

wordpress api blocks-revisions-list

getWpV2BlocksByParentRevisions — read (GET /wp/v2/blocks/{parent}/revisions)

wordpress api blocks-revisions-list [options]
OptionWhat it does
--parent <value>parent.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by object attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--allread every page, as the API pages it.

Example: wordpress personal api blocks-revisions-list --parent <value>

wordpress api blocks-revisions-get

getWpV2BlocksByParentRevisionsById — read (GET /wp/v2/blocks/{parent}/revisions/{id})

wordpress api blocks-revisions-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api blocks-revisions-get --parent <value> --id <value>

wordpress api blocks-revisions-delete

deleteWpV2BlocksByParentRevisionsById — destructive (DELETE /wp/v2/blocks/{parent}/revisions/{id})

Changes something in the service.

wordpress api blocks-revisions-delete [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--force <value>Required to be true, as revisions do not support trashing.

Example: wordpress personal api blocks-revisions-delete --parent <value> --id <value>

wordpress api categories-list

getWpV2Categories — read (GET /wp/v2/categories)

wordpress api categories-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--hide-empty <value>Whether to hide terms not assigned to any posts.
--include <value>Limit result set to specific IDs.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by term attribute.
--page <value>Current page of the collection.
--parent <value>Limit result set to terms assigned to a specific parent.
--per-page <value>Maximum number of items to be returned in result set.
--post <value>Limit result set to terms assigned to a specific post.
--search <value>Limit results to those matching a string.
--slug <value>Limit result set to terms with one or more specific slugs.
--allread every page, as the API pages it.

Example: wordpress personal api categories-list

wordpress api categories-create

postWpV2Categories — write (POST /wp/v2/categories)

Changes something in the service.

wordpress api categories-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api categories-create

wordpress api categories-get

getWpV2CategoriesById — read (GET /wp/v2/categories/{id})

wordpress api categories-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api categories-get --id <value>

wordpress api categories-update

postWpV2CategoriesById — write (POST /wp/v2/categories/{id})

Changes something in the service.

wordpress api categories-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api categories-update --id <value>

wordpress api categories-delete

deleteWpV2CategoriesById — destructive (DELETE /wp/v2/categories/{id})

Changes something in the service.

wordpress api categories-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Required to be true, as terms do not support trashing.

Example: wordpress personal api categories-delete --id <value>

wordpress api comments-list

getWpV2Comments — read (GET /wp/v2/comments)

wordpress api comments-list [options]
OptionWhat it does
--after <value>Limit response to comments published after a given ISO8601 compliant date.
--author <value>Limit result set to comments assigned to specific user IDs. Requires authorization.
--author-email <value>Limit result set to that from a specific author email. Requires authorization.
--author-exclude <value>Ensure result set excludes comments assigned to specific user IDs. Requires authorization.
--before <value>Limit response to comments published before a given ISO8601 compliant date.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by comment attribute.
--page <value>Current page of the collection.
--parent <value>Limit result set to comments of specific parent IDs.
--parent-exclude <value>Ensure result set excludes specific parent IDs.
--password <value>The password for the post if it is password protected.
--per-page <value>Maximum number of items to be returned in result set.
--post <value>Limit result set to comments assigned to specific post IDs.
--search <value>Limit results to those matching a string.
--status <value>Limit result set to comments assigned a specific status. Requires authorization.
--type <value>Limit result set to comments assigned a specific type. Requires authorization.
--allread every page, as the API pages it.

Example: wordpress personal api comments-list

wordpress api comments-create

postWpV2Comments — write (POST /wp/v2/comments)

Changes something in the service.

wordpress api comments-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api comments-create

wordpress api comments-get

getWpV2CommentsById — read (GET /wp/v2/comments/{id})

wordpress api comments-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--password <value>The password for the parent post of the comment (if the post is password protected).

Example: wordpress personal api comments-get --id <value>

wordpress api comments-update

postWpV2CommentsById — write (POST /wp/v2/comments/{id})

Changes something in the service.

wordpress api comments-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api comments-update --id <value>

wordpress api comments-delete

deleteWpV2CommentsById — destructive (DELETE /wp/v2/comments/{id})

Changes something in the service.

wordpress api comments-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.
--password <value>The password for the parent post of the comment (if the post is password protected).

Example: wordpress personal api comments-delete --id <value>

wordpress api font-collections-list

getWpV2FontCollections — read (GET /wp/v2/font-collections)

wordpress api font-collections-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--allread every page, as the API pages it.

Example: wordpress personal api font-collections-list

wordpress api font-families-list

getWpV2FontFamilies — read (GET /wp/v2/font-families)

wordpress api font-families-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search-semantics <value>How to interpret the search input.
--slug <value>Limit result set to posts with one or more specific slugs.
--allread every page, as the API pages it.

Example: wordpress personal api font-families-list

wordpress api font-families-create

postWpV2FontFamilies — write (POST /wp/v2/font-families)

Changes something in the service.

wordpress api font-families-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api font-families-create

wordpress api font-families-font-faces-list

getWpV2FontFamiliesByFontFamilyIdFontFaces — read (GET /wp/v2/font-families/{font_family_id}/font-faces)

wordpress api font-families-font-faces-list [options]
OptionWhat it does
--font-family-id <value>font_family_id.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search-semantics <value>How to interpret the search input.
--allread every page, as the API pages it.

Example: wordpress personal api font-families-font-faces-list --font-family-id <value>

wordpress api font-families-font-faces-create

postWpV2FontFamiliesByFontFamilyIdFontFaces — write (POST /wp/v2/font-families/{font_family_id}/font-faces)

Changes something in the service.

wordpress api font-families-font-faces-create [options]
OptionWhat it does
--font-family-id <value>font_family_id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api font-families-font-faces-create --font-family-id <value>

wordpress api font-families-font-faces-get

getWpV2FontFamiliesByFontFamilyIdFontFacesById — read (GET /wp/v2/font-families/{font_family_id}/font-faces/{id})

wordpress api font-families-font-faces-get [options]
OptionWhat it does
--font-family-id <value>font_family_id.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api font-families-font-faces-get --font-family-id <value> --id <value>

wordpress api font-families-font-faces-delete

deleteWpV2FontFamiliesByFontFamilyIdFontFacesById — destructive (DELETE /wp/v2/font-families/{font_family_id}/font-faces/{id})

Changes something in the service.

wordpress api font-families-font-faces-delete [options]
OptionWhat it does
--font-family-id <value>font_family_id.
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api font-families-font-faces-delete --font-family-id <value> --id <value>

wordpress api font-families-get

getWpV2FontFamiliesById — read (GET /wp/v2/font-families/{id})

wordpress api font-families-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api font-families-get --id <value>

wordpress api font-families-update

postWpV2FontFamiliesById — write (POST /wp/v2/font-families/{id})

Changes something in the service.

wordpress api font-families-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api font-families-update --id <value>

wordpress api font-families-delete

deleteWpV2FontFamiliesById — destructive (DELETE /wp/v2/font-families/{id})

Changes something in the service.

wordpress api font-families-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api font-families-delete --id <value>

wordpress api global-styles-revisions-list

getWpV2GlobalStylesByParentRevisions — read (GET /wp/v2/global-styles/{parent}/revisions)

wordpress api global-styles-revisions-list [options]
OptionWhat it does
--parent <value>parent.
--context <value>Scope under which the request is made; determines fields present in response.
--offset <value>Offset the result set by a specific number of items.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--allread every page, as the API pages it.

Example: wordpress personal api global-styles-revisions-list --parent <value>

wordpress api global-styles-revisions-get

getWpV2GlobalStylesByParentRevisionsById — read (GET /wp/v2/global-styles/{parent}/revisions/{id})

wordpress api global-styles-revisions-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api global-styles-revisions-get --parent <value> --id <value>

wordpress api media-list

getWpV2Media — read (GET /wp/v2/media)

wordpress api media-list [options]
OptionWhat it does
--after <value>Limit response to posts published after a given ISO8601 compliant date.
--author <value>Limit result set to posts assigned to specific authors.
--author-exclude <value>Ensure result set excludes posts assigned to specific authors.
--before <value>Limit response to posts published before a given ISO8601 compliant date.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--media-type <value>Limit result set to attachments of a particular media type or media types.
--mime-type <value>Limit result set to attachments of a particular MIME type or MIME types.
--modified-after <value>Limit response to posts modified after a given ISO8601 compliant date.
--modified-before <value>Limit response to posts modified before a given ISO8601 compliant date.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--parent <value>Limit result set to items with particular parent IDs.
--parent-exclude <value>Limit result set to all items except those of a particular parent ID.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--search-columns <value>Array of column names to be searched.
--search-semantics <value>How to interpret the search input.
--slug <value>Limit result set to posts with one or more specific slugs.
--status <value>Limit result set to posts assigned one or more statuses.
--allread every page, as the API pages it.

Example: wordpress personal api media-list

wordpress api media-create

postWpV2Media — write (POST /wp/v2/media)

Changes something in the service.

wordpress api media-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api media-create

wordpress api media-get

getWpV2MediaById — read (GET /wp/v2/media/{id})

wordpress api media-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api media-get --id <value>

wordpress api media-update

postWpV2MediaById — write (POST /wp/v2/media/{id})

Changes something in the service.

wordpress api media-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api media-update --id <value>

wordpress api media-delete

deleteWpV2MediaById — destructive (DELETE /wp/v2/media/{id})

Changes something in the service.

wordpress api media-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api media-delete --id <value>

wordpress api media-edit

postWpV2MediaByIdEdit — write (POST /wp/v2/media/{id}/edit)

Changes something in the service.

wordpress api media-edit [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api media-edit --id <value>

wordpress api media-post-process

postWpV2MediaByIdPostProcess — write (POST /wp/v2/media/{id}/post-process)

Changes something in the service.

wordpress api media-post-process [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api media-post-process --id <value>

wordpress api menu-items-list

getWpV2MenuItems — read (GET /wp/v2/menu-items)

wordpress api menu-items-list [options]
OptionWhat it does
--after <value>Limit response to posts published after a given ISO8601 compliant date.
--before <value>Limit response to posts published before a given ISO8601 compliant date.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--menu-order <value>Limit result set to posts with a specific menu_order value.
--menus <value>Limit result set to items with specific terms assigned in the menus taxonomy.
--menus-exclude <value>Limit result set to items except those with specific terms assigned in the menus taxonomy.
--modified-after <value>Limit response to posts modified after a given ISO8601 compliant date.
--modified-before <value>Limit response to posts modified before a given ISO8601 compliant date.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by object attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--search-columns <value>Array of column names to be searched.
--search-semantics <value>How to interpret the search input.
--slug <value>Limit result set to posts with one or more specific slugs.
--status <value>Limit result set to posts assigned one or more statuses.
--tax-relation <value>Limit result set based on relationship between multiple taxonomies.
--allread every page, as the API pages it.

Example: wordpress personal api menu-items-list

wordpress api menu-items-create

postWpV2MenuItems — write (POST /wp/v2/menu-items)

Changes something in the service.

wordpress api menu-items-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api menu-items-create

wordpress api menu-items-get

getWpV2MenuItemsById — read (GET /wp/v2/menu-items/{id})

wordpress api menu-items-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api menu-items-get --id <value>

wordpress api menu-items-update

postWpV2MenuItemsById — write (POST /wp/v2/menu-items/{id})

Changes something in the service.

wordpress api menu-items-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api menu-items-update --id <value>

wordpress api menu-items-delete

deleteWpV2MenuItemsById — destructive (DELETE /wp/v2/menu-items/{id})

Changes something in the service.

wordpress api menu-items-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api menu-items-delete --id <value>

wordpress api menu-items-autosaves-list

getWpV2MenuItemsByIdAutosaves — read (GET /wp/v2/menu-items/{id}/autosaves)

wordpress api menu-items-autosaves-list [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--parent <value>The ID for the parent of the autosave.

Example: wordpress personal api menu-items-autosaves-list --id <value>

wordpress api menu-items-autosaves-create

postWpV2MenuItemsByIdAutosaves — write (POST /wp/v2/menu-items/{id}/autosaves)

Changes something in the service.

wordpress api menu-items-autosaves-create [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api menu-items-autosaves-create --id <value>

wordpress api menu-items-autosaves-get

getWpV2MenuItemsByParentAutosavesById — read (GET /wp/v2/menu-items/{parent}/autosaves/{id})

wordpress api menu-items-autosaves-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api menu-items-autosaves-get --parent <value> --id <value>

wordpress api menu-locations-list

getWpV2MenuLocations — read (GET /wp/v2/menu-locations)

wordpress api menu-locations-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api menu-locations-list

wordpress api menu-locations-get

getWpV2MenuLocationsByLocation — read (GET /wp/v2/menu-locations/{location})

wordpress api menu-locations-get [options]
OptionWhat it does
--location <value>location.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api menu-locations-get --location <value>

wordpress api menus-list

getWpV2Menus — read (GET /wp/v2/menus)

wordpress api menus-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--hide-empty <value>Whether to hide terms not assigned to any posts.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by term attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--post <value>Limit result set to terms assigned to a specific post.
--search <value>Limit results to those matching a string.
--slug <value>Limit result set to terms with one or more specific slugs.
--allread every page, as the API pages it.

Example: wordpress personal api menus-list

wordpress api menus-create

postWpV2Menus — write (POST /wp/v2/menus)

Changes something in the service.

wordpress api menus-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api menus-create

wordpress api menus-get

getWpV2MenusById — read (GET /wp/v2/menus/{id})

wordpress api menus-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api menus-get --id <value>

wordpress api menus-update

postWpV2MenusById — write (POST /wp/v2/menus/{id})

Changes something in the service.

wordpress api menus-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api menus-update --id <value>

wordpress api menus-delete

deleteWpV2MenusById — destructive (DELETE /wp/v2/menus/{id})

Changes something in the service.

wordpress api menus-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Required to be true, as terms do not support trashing.

Example: wordpress personal api menus-delete --id <value>

wordpress api navigation-list

getWpV2Navigation — read (GET /wp/v2/navigation)

wordpress api navigation-list [options]
OptionWhat it does
--after <value>Limit response to posts published after a given ISO8601 compliant date.
--before <value>Limit response to posts published before a given ISO8601 compliant date.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--modified-after <value>Limit response to posts modified after a given ISO8601 compliant date.
--modified-before <value>Limit response to posts modified before a given ISO8601 compliant date.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--search-columns <value>Array of column names to be searched.
--search-semantics <value>How to interpret the search input.
--slug <value>Limit result set to posts with one or more specific slugs.
--status <value>Limit result set to posts assigned one or more statuses.
--allread every page, as the API pages it.

Example: wordpress personal api navigation-list

wordpress api navigation-create

postWpV2Navigation — write (POST /wp/v2/navigation)

Changes something in the service.

wordpress api navigation-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api navigation-create

wordpress api navigation-get

getWpV2NavigationById — read (GET /wp/v2/navigation/{id})

wordpress api navigation-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--password <value>The password for the post if it is password protected.

Example: wordpress personal api navigation-get --id <value>

wordpress api navigation-update

postWpV2NavigationById — write (POST /wp/v2/navigation/{id})

Changes something in the service.

wordpress api navigation-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api navigation-update --id <value>

wordpress api navigation-delete

deleteWpV2NavigationById — destructive (DELETE /wp/v2/navigation/{id})

Changes something in the service.

wordpress api navigation-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api navigation-delete --id <value>

wordpress api navigation-autosaves-list

getWpV2NavigationByIdAutosaves — read (GET /wp/v2/navigation/{id}/autosaves)

wordpress api navigation-autosaves-list [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--parent <value>The ID for the parent of the autosave.

Example: wordpress personal api navigation-autosaves-list --id <value>

wordpress api navigation-autosaves-create

postWpV2NavigationByIdAutosaves — write (POST /wp/v2/navigation/{id}/autosaves)

Changes something in the service.

wordpress api navigation-autosaves-create [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api navigation-autosaves-create --id <value>

wordpress api navigation-autosaves-get

getWpV2NavigationByParentAutosavesById — read (GET /wp/v2/navigation/{parent}/autosaves/{id})

wordpress api navigation-autosaves-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api navigation-autosaves-get --parent <value> --id <value>

wordpress api navigation-revisions-list

getWpV2NavigationByParentRevisions — read (GET /wp/v2/navigation/{parent}/revisions)

wordpress api navigation-revisions-list [options]
OptionWhat it does
--parent <value>parent.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by object attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--allread every page, as the API pages it.

Example: wordpress personal api navigation-revisions-list --parent <value>

wordpress api navigation-revisions-get

getWpV2NavigationByParentRevisionsById — read (GET /wp/v2/navigation/{parent}/revisions/{id})

wordpress api navigation-revisions-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api navigation-revisions-get --parent <value> --id <value>

wordpress api navigation-revisions-delete

deleteWpV2NavigationByParentRevisionsById — destructive (DELETE /wp/v2/navigation/{parent}/revisions/{id})

Changes something in the service.

wordpress api navigation-revisions-delete [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--force <value>Required to be true, as revisions do not support trashing.

Example: wordpress personal api navigation-revisions-delete --parent <value> --id <value>

wordpress api pages-list

getWpV2Pages — read (GET /wp/v2/pages)

wordpress api pages-list [options]
OptionWhat it does
--after <value>Limit response to posts published after a given ISO8601 compliant date.
--author <value>Limit result set to posts assigned to specific authors.
--author-exclude <value>Ensure result set excludes posts assigned to specific authors.
--before <value>Limit response to posts published before a given ISO8601 compliant date.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--menu-order <value>Limit result set to posts with a specific menu_order value.
--modified-after <value>Limit response to posts modified after a given ISO8601 compliant date.
--modified-before <value>Limit response to posts modified before a given ISO8601 compliant date.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--parent <value>Limit result set to items with particular parent IDs.
--parent-exclude <value>Limit result set to all items except those of a particular parent ID.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--search-columns <value>Array of column names to be searched.
--search-semantics <value>How to interpret the search input.
--slug <value>Limit result set to posts with one or more specific slugs.
--status <value>Limit result set to posts assigned one or more statuses.
--allread every page, as the API pages it.

Example: wordpress personal api pages-list

wordpress api pages-create

postWpV2Pages — write (POST /wp/v2/pages)

Changes something in the service.

wordpress api pages-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api pages-create

wordpress api pages-get

getWpV2PagesById — read (GET /wp/v2/pages/{id})

wordpress api pages-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--excerpt-length <value>Override the default excerpt length.
--password <value>The password for the post if it is password protected.

Example: wordpress personal api pages-get --id <value>

wordpress api pages-update

postWpV2PagesById — write (POST /wp/v2/pages/{id})

Changes something in the service.

wordpress api pages-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api pages-update --id <value>

wordpress api pages-delete

deleteWpV2PagesById — destructive (DELETE /wp/v2/pages/{id})

Changes something in the service.

wordpress api pages-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api pages-delete --id <value>

wordpress api pages-autosaves-list

getWpV2PagesByIdAutosaves — read (GET /wp/v2/pages/{id}/autosaves)

wordpress api pages-autosaves-list [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--parent <value>The ID for the parent of the autosave.

Example: wordpress personal api pages-autosaves-list --id <value>

wordpress api pages-autosaves-create

postWpV2PagesByIdAutosaves — write (POST /wp/v2/pages/{id}/autosaves)

Changes something in the service.

wordpress api pages-autosaves-create [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api pages-autosaves-create --id <value>

wordpress api pages-autosaves-get

getWpV2PagesByParentAutosavesById — read (GET /wp/v2/pages/{parent}/autosaves/{id})

wordpress api pages-autosaves-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api pages-autosaves-get --parent <value> --id <value>

wordpress api pages-revisions-list

getWpV2PagesByParentRevisions — read (GET /wp/v2/pages/{parent}/revisions)

wordpress api pages-revisions-list [options]
OptionWhat it does
--parent <value>parent.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by object attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--allread every page, as the API pages it.

Example: wordpress personal api pages-revisions-list --parent <value>

wordpress api pages-revisions-get

getWpV2PagesByParentRevisionsById — read (GET /wp/v2/pages/{parent}/revisions/{id})

wordpress api pages-revisions-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api pages-revisions-get --parent <value> --id <value>

wordpress api pages-revisions-delete

deleteWpV2PagesByParentRevisionsById — destructive (DELETE /wp/v2/pages/{parent}/revisions/{id})

Changes something in the service.

wordpress api pages-revisions-delete [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--force <value>Required to be true, as revisions do not support trashing.

Example: wordpress personal api pages-revisions-delete --parent <value> --id <value>

wordpress api pattern-directory-patterns-list

getWpV2PatternDirectoryPatterns — read (GET /wp/v2/pattern-directory/patterns)

wordpress api pattern-directory-patterns-list [options]
OptionWhat it does
--category <value>Limit results to those matching a category ID.
--context <value>Scope under which the request is made; determines fields present in response.
--keyword <value>Limit results to those matching a keyword ID.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--slug <value>Limit results to those matching a pattern (slug).
--allread every page, as the API pages it.

Example: wordpress personal api pattern-directory-patterns-list

wordpress api plugins-list

getWpV2Plugins — read (GET /wp/v2/plugins)

wordpress api plugins-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--search <value>Limit results to those matching a string.
--status <value>Limits results to plugins with the given status.

Example: wordpress personal api plugins-list

wordpress api plugins-create

postWpV2Plugins — write (POST /wp/v2/plugins)

Changes something in the service.

wordpress api plugins-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api plugins-create

wordpress api posts-list

getWpV2Posts — read (GET /wp/v2/posts)

wordpress api posts-list [options]
OptionWhat it does
--after <value>Limit response to posts published after a given ISO8601 compliant date.
--author <value>Limit result set to posts assigned to specific authors.
--author-exclude <value>Ensure result set excludes posts assigned to specific authors.
--before <value>Limit response to posts published before a given ISO8601 compliant date.
--categories <value>Limit result set to items with specific terms assigned in the categories taxonomy.
--categories-exclude <value>Limit result set to items except those with specific terms assigned in the categories taxonomy.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--format <value>Limit result set to items assigned one or more given formats.
--ignore-sticky <value>Whether to ignore sticky posts or not.
--include <value>Limit result set to specific IDs.
--modified-after <value>Limit response to posts modified after a given ISO8601 compliant date.
--modified-before <value>Limit response to posts modified before a given ISO8601 compliant date.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by post attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--search-columns <value>Array of column names to be searched.
--search-semantics <value>How to interpret the search input.
--slug <value>Limit result set to posts with one or more specific slugs.
--status <value>Limit result set to posts assigned one or more statuses.
--sticky <value>Limit result set to items that are sticky.
--tags <value>Limit result set to items with specific terms assigned in the tags taxonomy.
--tags-exclude <value>Limit result set to items except those with specific terms assigned in the tags taxonomy.
--tax-relation <value>Limit result set based on relationship between multiple taxonomies.
--allread every page, as the API pages it.

Example: wordpress personal api posts-list

wordpress api posts-create

postWpV2Posts — write (POST /wp/v2/posts)

Changes something in the service.

wordpress api posts-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api posts-create

wordpress api posts-get

getWpV2PostsById — read (GET /wp/v2/posts/{id})

wordpress api posts-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--excerpt-length <value>Override the default excerpt length.
--password <value>The password for the post if it is password protected.

Example: wordpress personal api posts-get --id <value>

wordpress api posts-update

postWpV2PostsById — write (POST /wp/v2/posts/{id})

Changes something in the service.

wordpress api posts-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api posts-update --id <value>

wordpress api posts-delete

deleteWpV2PostsById — destructive (DELETE /wp/v2/posts/{id})

Changes something in the service.

wordpress api posts-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to bypass Trash and force deletion.

Example: wordpress personal api posts-delete --id <value>

wordpress api posts-autosaves-list

getWpV2PostsByIdAutosaves — read (GET /wp/v2/posts/{id}/autosaves)

wordpress api posts-autosaves-list [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.
--parent <value>The ID for the parent of the autosave.

Example: wordpress personal api posts-autosaves-list --id <value>

wordpress api posts-autosaves-create

postWpV2PostsByIdAutosaves — write (POST /wp/v2/posts/{id}/autosaves)

Changes something in the service.

wordpress api posts-autosaves-create [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api posts-autosaves-create --id <value>

wordpress api posts-autosaves-get

getWpV2PostsByParentAutosavesById — read (GET /wp/v2/posts/{parent}/autosaves/{id})

wordpress api posts-autosaves-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api posts-autosaves-get --parent <value> --id <value>

wordpress api posts-revisions-list

getWpV2PostsByParentRevisions — read (GET /wp/v2/posts/{parent}/revisions)

wordpress api posts-revisions-list [options]
OptionWhat it does
--parent <value>parent.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by object attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--allread every page, as the API pages it.

Example: wordpress personal api posts-revisions-list --parent <value>

wordpress api posts-revisions-get

getWpV2PostsByParentRevisionsById — read (GET /wp/v2/posts/{parent}/revisions/{id})

wordpress api posts-revisions-get [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api posts-revisions-get --parent <value> --id <value>

wordpress api posts-revisions-delete

deleteWpV2PostsByParentRevisionsById — destructive (DELETE /wp/v2/posts/{parent}/revisions/{id})

Changes something in the service.

wordpress api posts-revisions-delete [options]
OptionWhat it does
--parent <value>parent.
--id <value>id.
--force <value>Required to be true, as revisions do not support trashing.

Example: wordpress personal api posts-revisions-delete --parent <value> --id <value>

wordpress api search-list

getWpV2Search — read (GET /wp/v2/search)

wordpress api search-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--include <value>Limit result set to specific IDs.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--search <value>Limit results to those matching a string.
--subtype <value>Limit results to items of one or more object subtypes.
--type <value>Limit results to items of an object type.
--allread every page, as the API pages it.

Example: wordpress personal api search-list

wordpress api settings-list

getWpV2Settings — read (GET /wp/v2/settings)

wordpress api settings-list

Example: wordpress personal api settings-list

wordpress api settings-create

postWpV2Settings — write (POST /wp/v2/settings)

Changes something in the service.

wordpress api settings-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api settings-create

wordpress api sidebars-list

getWpV2Sidebars — read (GET /wp/v2/sidebars)

wordpress api sidebars-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api sidebars-list

wordpress api sidebars-get

getWpV2SidebarsById — read (GET /wp/v2/sidebars/{id})

wordpress api sidebars-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api sidebars-get --id <value>

wordpress api sidebars-update

postWpV2SidebarsById — write (POST /wp/v2/sidebars/{id})

Changes something in the service.

wordpress api sidebars-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api sidebars-update --id <value>

wordpress api statuses-list

getWpV2Statuses — read (GET /wp/v2/statuses)

wordpress api statuses-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api statuses-list

wordpress api statuses-get

getWpV2StatusesByStatus — read (GET /wp/v2/statuses/{status})

wordpress api statuses-get [options]
OptionWhat it does
--status <value>status.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api statuses-get --status <value>

wordpress api tags-list

getWpV2Tags — read (GET /wp/v2/tags)

wordpress api tags-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--hide-empty <value>Whether to hide terms not assigned to any posts.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by term attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--post <value>Limit result set to terms assigned to a specific post.
--search <value>Limit results to those matching a string.
--slug <value>Limit result set to terms with one or more specific slugs.
--allread every page, as the API pages it.

Example: wordpress personal api tags-list

wordpress api tags-create

postWpV2Tags — write (POST /wp/v2/tags)

Changes something in the service.

wordpress api tags-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api tags-create

wordpress api tags-get

getWpV2TagsById — read (GET /wp/v2/tags/{id})

wordpress api tags-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api tags-get --id <value>

wordpress api tags-update

postWpV2TagsById — write (POST /wp/v2/tags/{id})

Changes something in the service.

wordpress api tags-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api tags-update --id <value>

wordpress api tags-delete

deleteWpV2TagsById — destructive (DELETE /wp/v2/tags/{id})

Changes something in the service.

wordpress api tags-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Required to be true, as terms do not support trashing.

Example: wordpress personal api tags-delete --id <value>

wordpress api taxonomies-list

getWpV2Taxonomies — read (GET /wp/v2/taxonomies)

wordpress api taxonomies-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--type <value>Limit results to taxonomies associated with a specific post type.

Example: wordpress personal api taxonomies-list

wordpress api taxonomies-get

getWpV2TaxonomiesByTaxonomy — read (GET /wp/v2/taxonomies/{taxonomy})

wordpress api taxonomies-get [options]
OptionWhat it does
--taxonomy <value>taxonomy.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api taxonomies-get --taxonomy <value>

wordpress api template-parts-list

getWpV2TemplateParts — read (GET /wp/v2/template-parts)

wordpress api template-parts-list [options]
OptionWhat it does
--area <value>Limit to the specified template part area.
--context <value>Scope under which the request is made; determines fields present in response.
--post-type <value>Post type to get the templates for.
--wp-id <value>Limit to the specified post id.

Example: wordpress personal api template-parts-list

wordpress api template-parts-create

postWpV2TemplateParts — write (POST /wp/v2/template-parts)

Changes something in the service.

wordpress api template-parts-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api template-parts-create

wordpress api template-parts-lookup-list

getWpV2TemplatePartsLookup — read (GET /wp/v2/template-parts/lookup)

wordpress api template-parts-lookup-list [options]
OptionWhat it does
--is-custom <value>Indicates if a template is custom or part of the template hierarchy.
--slug <value>The slug of the template to get the fallback for.
--template-prefix <value>The template prefix for the created template. This is used to extract the main template type, e.g. in taxonomy-books extracts the taxonomy.

Example: wordpress personal api template-parts-lookup-list --slug <value>

wordpress api templates-list

getWpV2Templates — read (GET /wp/v2/templates)

wordpress api templates-list [options]
OptionWhat it does
--area <value>Limit to the specified template part area.
--context <value>Scope under which the request is made; determines fields present in response.
--post-type <value>Post type to get the templates for.
--wp-id <value>Limit to the specified post id.

Example: wordpress personal api templates-list

wordpress api templates-create

postWpV2Templates — write (POST /wp/v2/templates)

Changes something in the service.

wordpress api templates-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api templates-create

wordpress api templates-lookup-list

getWpV2TemplatesLookup — read (GET /wp/v2/templates/lookup)

wordpress api templates-lookup-list [options]
OptionWhat it does
--is-custom <value>Indicates if a template is custom or part of the template hierarchy.
--slug <value>The slug of the template to get the fallback for.
--template-prefix <value>The template prefix for the created template. This is used to extract the main template type, e.g. in taxonomy-books extracts the taxonomy.

Example: wordpress personal api templates-lookup-list --slug <value>

wordpress api themes-list

getWpV2Themes — read (GET /wp/v2/themes)

wordpress api themes-list [options]
OptionWhat it does
--status <value>Limit result set to themes assigned one or more statuses.

Example: wordpress personal api themes-list

wordpress api types-list

getWpV2Types — read (GET /wp/v2/types)

wordpress api types-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api types-list

wordpress api types-get

getWpV2TypesByType — read (GET /wp/v2/types/{type})

wordpress api types-get [options]
OptionWhat it does
--type <value>type.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api types-get --type <value>

wordpress api users-list

getWpV2Users — read (GET /wp/v2/users)

wordpress api users-list [options]
OptionWhat it does
--capabilities <value>Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--has-published-posts <value>Limit result set to users who have published posts.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by user attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--roles <value>Limit result set to users matching at least one specific role provided. Accepts csv list or single role.
--search <value>Limit results to those matching a string.
--search-columns <value>Array of column names to be searched.
--slug <value>Limit result set to users with one or more specific slugs.
--who <value>Limit result set to users who are considered authors.
--allread every page, as the API pages it.

Example: wordpress personal api users-list

wordpress api users-create

postWpV2Users — write (POST /wp/v2/users)

Changes something in the service.

wordpress api users-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api users-create

wordpress api users-get

getWpV2UsersById — read (GET /wp/v2/users/{id})

wordpress api users-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api users-get --id <value>

wordpress api users-update

postWpV2UsersById — write (POST /wp/v2/users/{id})

Changes something in the service.

wordpress api users-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api users-update --id <value>

wordpress api users-delete

deleteWpV2UsersById — destructive (DELETE /wp/v2/users/{id})

Changes something in the service.

wordpress api users-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Required to be true, as users do not support trashing.
--reassign <value>Reassign the deleted user's posts and links to this user ID.

Example: wordpress personal api users-delete --id <value> --reassign <value>

wordpress api users-application-passwords-get

getWpV2UsersByUserIdApplicationPasswordsByUuid — read (GET /wp/v2/users/{user_id}/application-passwords/{uuid})

wordpress api users-application-passwords-get [options]
OptionWhat it does
--user-id <value>user_id.
--uuid <value>uuid.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api users-application-passwords-get --user-id <value> --uuid <value>

wordpress api users-application-passwords-update

postWpV2UsersByUserIdApplicationPasswordsByUuid — write (POST /wp/v2/users/{user_id}/application-passwords/{uuid})

Changes something in the service.

wordpress api users-application-passwords-update [options]
OptionWhat it does
--user-id <value>user_id.
--uuid <value>uuid.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api users-application-passwords-update --user-id <value> --uuid <value>

wordpress api users-application-passwords-delete

deleteWpV2UsersByUserIdApplicationPasswordsByUuid — destructive (DELETE /wp/v2/users/{user_id}/application-passwords/{uuid})

Changes something in the service.

wordpress api users-application-passwords-delete [options]
OptionWhat it does
--user-id <value>user_id.
--uuid <value>uuid.

Example: wordpress personal api users-application-passwords-delete --user-id <value> --uuid <value>

wordpress api users-application-passwords-introspect-list

getWpV2UsersByUserIdApplicationPasswordsIntrospect — read (GET /wp/v2/users/{user_id}/application-passwords/introspect)

wordpress api users-application-passwords-introspect-list [options]
OptionWhat it does
--user-id <value>user_id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api users-application-passwords-introspect-list --user-id <value>

wordpress api users-me-get

getWpV2UsersMe — read (GET /wp/v2/users/me)

wordpress api users-me-get [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api users-me-get

wordpress api users-me-create

postWpV2UsersMe — write (POST /wp/v2/users/me)

Changes something in the service.

wordpress api users-me-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api users-me-create

wordpress api users-me-delete

deleteWpV2UsersMe — destructive (DELETE /wp/v2/users/me)

Changes something in the service.

wordpress api users-me-delete [options]
OptionWhat it does
--force <value>Required to be true, as users do not support trashing.
--reassign <value>Reassign the deleted user's posts and links to this user ID.

Example: wordpress personal api users-me-delete --reassign <value>

wordpress api widget-types-list

getWpV2WidgetTypes — read (GET /wp/v2/widget-types)

wordpress api widget-types-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api widget-types-list

wordpress api widget-types-get

getWpV2WidgetTypesById — read (GET /wp/v2/widget-types/{id})

wordpress api widget-types-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api widget-types-get --id <value>

wordpress api widget-types-encode

postWpV2WidgetTypesByIdEncode — write (POST /wp/v2/widget-types/{id}/encode)

Changes something in the service.

wordpress api widget-types-encode [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api widget-types-encode --id <value>

wordpress api widget-types-render

postWpV2WidgetTypesByIdRender — write (POST /wp/v2/widget-types/{id}/render)

Changes something in the service.

wordpress api widget-types-render [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api widget-types-render --id <value>

wordpress api widgets-list

getWpV2Widgets — read (GET /wp/v2/widgets)

wordpress api widgets-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--sidebar <value>The sidebar to return widgets for.

Example: wordpress personal api widgets-list

wordpress api widgets-create

postWpV2Widgets — write (POST /wp/v2/widgets)

Changes something in the service.

wordpress api widgets-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api widgets-create

wordpress api widgets-get

getWpV2WidgetsById — read (GET /wp/v2/widgets/{id})

wordpress api widgets-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api widgets-get --id <value>

wordpress api widgets-update

postWpV2WidgetsById — write (POST /wp/v2/widgets/{id})

Changes something in the service.

wordpress api widgets-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api widgets-update --id <value>

wordpress api widgets-delete

deleteWpV2WidgetsById — destructive (DELETE /wp/v2/widgets/{id})

Changes something in the service.

wordpress api widgets-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Whether to force removal of the widget, or move it to the inactive sidebar.

Example: wordpress personal api widgets-delete --id <value>

wordpress api wp-pattern-category-list

getWpV2WpPatternCategory — read (GET /wp/v2/wp_pattern_category)

wordpress api wp-pattern-category-list [options]
OptionWhat it does
--context <value>Scope under which the request is made; determines fields present in response.
--exclude <value>Ensure result set excludes specific IDs.
--hide-empty <value>Whether to hide terms not assigned to any posts.
--include <value>Limit result set to specific IDs.
--offset <value>Offset the result set by a specific number of items.
--order <value>Order sort attribute ascending or descending.
--orderby <value>Sort collection by term attribute.
--page <value>Current page of the collection.
--per-page <value>Maximum number of items to be returned in result set.
--post <value>Limit result set to terms assigned to a specific post.
--search <value>Limit results to those matching a string.
--slug <value>Limit result set to terms with one or more specific slugs.
--allread every page, as the API pages it.

Example: wordpress personal api wp-pattern-category-list

wordpress api wp-pattern-category-create

postWpV2WpPatternCategory — write (POST /wp/v2/wp_pattern_category)

Changes something in the service.

wordpress api wp-pattern-category-create [options]
OptionWhat it does
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api wp-pattern-category-create

wordpress api wp-pattern-category-get

getWpV2WpPatternCategoryById — read (GET /wp/v2/wp_pattern_category/{id})

wordpress api wp-pattern-category-get [options]
OptionWhat it does
--id <value>id.
--context <value>Scope under which the request is made; determines fields present in response.

Example: wordpress personal api wp-pattern-category-get --id <value>

wordpress api wp-pattern-category-update

postWpV2WpPatternCategoryById — write (POST /wp/v2/wp_pattern_category/{id})

Changes something in the service.

wordpress api wp-pattern-category-update [options]
OptionWhat it does
--id <value>id.
--body <json>the request body as JSON; - reads it from stdin.
--body-file <path>the request body from a JSON file; - is stdin.

Example: wordpress personal api wp-pattern-category-update --id <value>

wordpress api wp-pattern-category-delete

deleteWpV2WpPatternCategoryById — destructive (DELETE /wp/v2/wp_pattern_category/{id})

Changes something in the service.

wordpress api wp-pattern-category-delete [options]
OptionWhat it does
--id <value>id.
--force <value>Required to be true, as terms do not support trashing.

Example: wordpress personal api wp-pattern-category-delete --id <value>

wordpress sync

bring the copy of your posts up to date: channels, authors, tags and categories, and posts that changed since the last sync, or everything with --rescan. Once a day it also finds what the site deleted for good; trash stays a status. A site whose address changed, or a sign-in that sees only part, marks nothing deleted

Changes something on this computer only.

wordpress sync [options]
OptionWhat it does
--rescanlist everything again, every id too, dropping a round in progress.
--max-pages <pages>at most this many requests to the source in this run.

Returns: content sync — provider, account, state, complete, channels, due, metrics, synced, and 1 more; every field: wordpress commands info sync

Example: wordpress work sync, wordpress work sync --rescan

wordpress channels

the sites and social accounts this profile publishes on

wordpress channels list

the channels copied by the last sync

wordpress channels list [query]
ArgumentObligatoriedadWhat it is
queryoptionalfield:value terms; this list filters by none yet.

Returns: content channel — external_id, kind, network, name; every field: wordpress commands info channels list

Example: wordpress work channels list

wordpress posts

posts and pages as last synced, with their text as Markdown

wordpress posts list

posts copied from the source, newest change first; run sync to bring them up to date

wordpress posts list [query] [options]
ArgumentObligatoriedadWhat it is
queryoptionalfield:value terms that narrow the list — the fields are below.
OptionWhat it does
--limit <n>rows per page, 1–500. Default: 50.
--page <n>which page, starting at 1. Default: 1.

Returns: content post — kind, external_id, deleted; every field: wordpress commands info posts list

Example: wordpress work posts list status:draft, wordpress work posts list type:page published:>=2026-01-01

wordpress posts show

one post with its text, its authors and tags by name, its earlier versions and its last numbers

wordpress posts show <post>
ArgumentObligatoriedadWhat it is
postrequiredthe post's id at the source, as posts list shows it.

Returns: content post detail — kind, external_id, deleted; every field: wordpress commands info posts show

Example: wordpress work posts show 10

find posts in the copy by the words of their title and text

wordpress posts search <words> [options]
ArgumentObligatoriedadWhat it is
wordsrequiredevery word must match; prefixes of three letters or more match too.
OptionWhat it does
--limit <n>rows per page, 1–500. Default: 50.
--page <n>which page, starting at 1. Default: 1.

Returns: content hit — kind, external_id, deleted; every field: wordpress commands info posts search

Example: wordpress work posts search "pricing change"

wordpress posts stats

a post's readings of its numbers, one per sync, each kept, the newest first

wordpress posts stats <post>
ArgumentObligatoriedadWhat it is
postrequiredthe post's id at the source.

Returns: content metric — post, at; every field: wordpress commands info posts stats

Example: wordpress work posts stats 10

wordpress posts create

write a new draft; publishing is its own step, posts publish

Changes something in the service.

wordpress posts create [options]
OptionWhat it does
--title <title>the post's title.
--text-file <path>the text as Markdown, from a file, or - for stdin.
--description <text>the short text lists show, the excerpt.
--slug <slug>the address's last part.
--tags <ids>its tags and categories, by comma-separated ids as tags list shows them; replaces them.
--type <type>post or page; post when left out.

Returns: content write — operation_id, post; every field: wordpress commands info posts create

Example: wordpress work posts create --title 'Version 3' --text-file notes.md

wordpress posts update

change a post's fields; a published or scheduled post's change is public and checks posts.publish too

Changes something in the service.

wordpress posts update <post> [options]
ArgumentObligatoriedadWhat it is
postrequiredthe post's id at the source.
OptionWhat it does
--title <title>the post's title.
--text-file <path>the text as Markdown, from a file, or - for stdin.
--description <text>the short text lists show, the excerpt.
--slug <slug>the address's last part.
--tags <ids>its tags and categories, by comma-separated ids as tags list shows them; replaces them.
--replace-bodywrite the body over a post whose blocks or embeds Markdown cannot keep, flattening them.

Returns: content write — operation_id, post; every field: wordpress commands info posts update

Example: wordpress work posts update 10 --title 'Version 2 is out now'

wordpress posts publish

publish a post now, or at a later time with --at-time; a published post is answered as it is

Changes something in the service.

wordpress posts publish <post> [options]
ArgumentObligatoriedadWhat it is
postrequiredthe post's id at the source.
OptionWhat it does
--at-time <time>when it goes out instead of now: an ISO 8601 time, a day, or 3d from now; it must be ahead.

Returns: content write — operation_id, post; every field: wordpress commands info posts publish

Example: wordpress work posts publish 11, wordpress work posts publish 11 --at-time 2026-12-01T09:00:00Z

wordpress posts unpublish

bring a published or scheduled post back to a draft

Changes something in the service.

wordpress posts unpublish <post>
ArgumentObligatoriedadWhat it is
postrequiredthe post's id at the source.

Returns: content write — operation_id, post; every field: wordpress commands info posts unpublish

Example: wordpress work posts unpublish 11

wordpress posts delete

move a post to the source's trash, from which it comes back; --allow-delete deletes it for good

Changes something in the service.

wordpress posts delete <post> [options]
ArgumentObligatoriedadWhat it is
postrequiredthe post's id at the source.
OptionWhat it does
--allow-deletedelete it for good, past the trash; checks posts.delete.force.

Returns: content write — operation_id, post; every field: wordpress commands info posts delete

Example: wordpress work posts delete 11

wordpress users

the source's users who write, each with the person the store knows by the same e-mail

wordpress users list

users copied from the source

wordpress users list [query] [options]
ArgumentObligatoriedadWhat it is
queryoptionalfield:value terms; this list filters by none yet.
OptionWhat it does
--limit <n>rows per page, 1–500. Default: 50.
--page <n>which page, starting at 1. Default: 1.

Returns: content author — kind, external_id, deleted; every field: wordpress commands info users list

Example: wordpress work users list

wordpress tags

the source's tags and categories

wordpress tags list

tags copied from the source

wordpress tags list [query] [options]
ArgumentObligatoriedadWhat it is
queryoptionalfield:value terms; this list filters by none yet.
OptionWhat it does
--limit <n>rows per page, 1–500. Default: 50.
--page <n>which page, starting at 1. Default: 1.

Returns: content term — kind, external_id, deleted; every field: wordpress commands info tags list

Example: wordpress work tags list

wordpress doctor

the state this installation is in, without connecting unless --online

wordpress doctor [options]
OptionWhat it does
--onlinealso connect once and read the account; sends nothing.

Example: wordpress doctor, wordpress doctor --json

wordpress doctor reports

problem reports

wordpress doctor reports show

what a problem report holds; writes nothing

wordpress doctor reports show

Example: wordpress doctor reports show

wordpress doctor reports create

write a problem report to a file, and say where to send it

Changes something on this computer only.

wordpress doctor reports create [options]
OptionWhat it does
--run <id>the run the report is about; the newest failed one if not given.
--output <file>where to write it; a new file in this directory if not given.

Example: wordpress doctor reports create --output ./problem-report.json

wordpress skill

the instructions an agent is given for this tool

wordpress skill show

print SKILL.md — wordpress skill install puts it where Claude Code, Codex, Gemini CLI and OpenClaw look for it, and where Hermes does on request; --for prints the copy already there

wordpress skill show [name] [options]
ArgumentObligatoriedadWhat it is
nameoptionala part of this skill, or a skill shipped for a task: api-wp-pattern-category, api-widgets, api-widget-types, api-users, api-types, api-themes, api-templates, api-template-parts, api-taxonomies, api-tags, api-statuses, api-sidebars, api-settings, api-search, api-posts, api-plugins, api-pattern-directory, api-pages, api-navigation, api-menus, api-menu-locations, api-menu-items, api-media, api-global-styles, api-font-families, api-font-collections, api-comments, api-categories, api-blocks, api-block-types, api-block-patterns, api-block-directory, api.
OptionWhat it does
--for <agents>print the copy installed for these agents instead of this version's. One of: claude, agents.

Example: wordpress skill show

wordpress skill install

write SKILL.md to ~/.claude/skills/wordpress-cli/ (Claude Code) and ~/.agents/skills/wordpress-cli/ (Codex, Gemini CLI, OpenClaw); --for hermes also has Hermes read ~/.agents/skills, which changes Hermes's own settings, so all leaves it out

Changes something on this computer only.

wordpress skill install [options]
OptionWhat it does
--for <agents>which agents to install for. One of: claude, agents, hermes, all. Default: all.

Example: wordpress skill install --for agents

wordpress skill status

for each place wordpress skill install writes to, and for the copy Hermes reads: the path, the version installed there, and whether it is current, stale, missing or unversioned

wordpress skill status

Example: wordpress skill status, wordpress skill status --json

wordpress mcp

serve this profile to an agent over MCP and set it up — claude mcp add wordpress -- wordpress <profile> mcp serve

wordpress mcp serve

serve this profile to an agent over MCP, on stdin and stdout — claude mcp add wordpress -- wordpress <profile> mcp serve; wordpress mcp serve --profiles a,b or --profiles all serves those profiles from one server and each tool asks which

Changes something in the service.

wordpress mcp serve [options]
OptionWhat it does
--permission <key=level>make a permission stricter for this server only, like posts.publish=deny; it never loosens the profile; repeat for more keys.
--profiles <names|all>serve several profiles from one server instead of one: names, comma-separated, or all for every profile.
--httpserve over HTTP on 127.0.0.1 for ChatGPT and Claude in the browser, behind your tunnel; the profile's permissions decide.
--port <port>the local port for --http (default 8765).
--public-url <url>the tunnel's https address the browser apps use, e.g. https://.ts.net or https://.ts.net/tg.

Example: wordpress personal mcp serve, wordpress mcp serve --profiles work,personal, wordpress personal mcp serve --http --public-url https://laptop.example.ts.net

wordpress mcp revoke

forget every login mcp serve --http gave a browser app, of this profile or of the server --profiles names; each app must log in again

Changes something on this computer only.

wordpress mcp revoke [options]
OptionWhat it does
--profiles <names|all>serve several profiles from one server instead of one: names, comma-separated, or all for every profile.

Example: wordpress personal mcp revoke, wordpress mcp revoke --profiles all

wordpress mcp server

start, stop and check mcp serve --http in the background; status shows the login code for a browser app

wordpress mcp server start

start mcp serve --http apart from this shell and answer once it listens, with its login code

Changes something on this computer only.

wordpress mcp server start [options]
OptionWhat it does
--port <port>the local port (default 8765).
--public-url <url>the tunnel's https address the browser apps use, e.g. https://.ts.net or https://.ts.net/tg.
--permission <key=level>make a permission stricter for this server only; repeat for more keys.
--profiles <names|all>the server of several profiles that mcp serve --profiles serves: names, comma-separated, or all.

Example: wordpress personal mcp server start --public-url https://laptop.example.ts.net

wordpress mcp server stop

stop mcp serve --http — only one that mcp server start started

Changes something on this computer only.

wordpress mcp server stop [options]
OptionWhat it does
--profiles <names|all>the server of several profiles that mcp serve --profiles serves: names, comma-separated, or all.

Example: wordpress personal mcp server stop

wordpress mcp server status

whether mcp serve --http runs, on which port and address, the login code for a new browser app, and the apps logged in

wordpress mcp server status [options]
OptionWhat it does
--profiles <names|all>the server of several profiles that mcp serve --profiles serves: names, comma-separated, or all.

Example: wordpress personal mcp server status --json

wordpress mcp config

print the mcpServers entry for Claude Desktop, Cursor and others, with full paths; writes nothing

wordpress mcp config [options]
OptionWhat it does
--permission <key=level>make a permission stricter for this server only, like posts.publish=deny; it never loosens the profile; repeat for more keys.
--profiles <names|all>serve several profiles from one server instead of one: names, comma-separated, or all for every profile.

Example: wordpress personal mcp config, wordpress mcp config --profiles all

wordpress mcp add

add this profile's local MCP server to Codex or Claude Code

Changes something on this computer only.

wordpress mcp add <client> [options]
ArgumentObligatoriedadWhat it is
clientrequiredcodex or claude-code.
OptionWhat it does
--allow-writesacknowledge that this profile offers writing tools.
--permission <key=level>make a permission stricter for this server only, like posts.publish=deny; it never loosens the profile; repeat for more keys.

Example: wordpress personal mcp add codex --allow-writes

wordpress mcp check

check this profile's local MCP handshake and tool list

wordpress mcp check [options]
OptionWhat it does
--permission <key=level>make a permission stricter for this server only, like posts.publish=deny; it never loosens the profile; repeat for more keys.

Example: wordpress personal mcp check

wordpress upgrade

upgrade wordpress with the package manager that installed it; --check only looks

Changes something on this computer only.

wordpress upgrade [options]
OptionWhat it does
--checksay whether a newer version exists, and install nothing.

Example: wordpress upgrade --check

wordpress config

the settings in force, and where each one came from

wordpress config show

the profile, the profiles that exist, and each setting with where it came from

wordpress config show

Example: wordpress personal config show

wordpress config set

save a setting to the configuration file

Changes something on this computer only.

wordpress config set <setting> <value> [options]
ArgumentObligatoriedadWhat it is
settingrequiredone of: limit, timeout_ms, color, record, record_input, keep_runs_for_days, keep_successful_runs_for_days, keep_store_runs_for_days, runs_size_limit_mb, permissions, requests_per_minute, search_reranker, embedding_provider, embedding_model, embedding_base_url, embedding_dims, models, update_check, skill_hint, search_stemmers.cyrillic, search_stemmers.latin, owner_languages, crm.:.links, crm.:.company-types, crm.:.scope, crm.:.unassigned, crm.:.self, crm.:.stage-tasks, crm.:.activities, crm.:.files.max_files, crm.:.files.max_file_mb, crm.:.files.max_run_mb, crm.:.files.run_minutes, crm.:.files.days, crm.:.files.max_total_mb.
valuerequireda number, true or false; for a group tg:work,max:Alice,email:me@x.
OptionWhat it does
--defaultschange what every profile gets, rather than this profile.

Example: wordpress personal config set limit 20

wordpress config unset

remove a setting from the configuration file

Changes something on this computer only.

wordpress config unset <setting> [options]
ArgumentObligatoriedadWhat it is
settingrequiredone of: limit, timeout_ms, color, record, record_input, keep_runs_for_days, keep_successful_runs_for_days, keep_store_runs_for_days, runs_size_limit_mb, permissions, requests_per_minute, search_reranker, embedding_provider, embedding_model, embedding_base_url, embedding_dims, models, update_check, skill_hint, search_stemmers.cyrillic, search_stemmers.latin, owner_languages, crm.:.links, crm.:.company-types, crm.:.scope, crm.:.unassigned, crm.:.self, crm.:.stage-tasks, crm.:.activities, crm.:.files.max_files, crm.:.files.max_file_mb, crm.:.files.max_run_mb, crm.:.files.run_minutes, crm.:.files.days, crm.:.files.max_total_mb.
OptionWhat it does
--defaultschange what every profile gets, rather than this profile.

Example: wordpress personal config unset limit

wordpress config migrate

write each setting the file lacks at its default, keeping yours

Changes something on this computer only.

wordpress config migrate

Example: wordpress config migrate

wordpress config repair

fix broken JSON syntax in the settings file — comments, a missing or extra comma, unquoted keys, single quotes, missing closing brackets at the end — keeping every value, with a backup beside it; refuses anything with more than one reading and changes nothing then

Changes something on this computer only.

wordpress config repair [options]
OptionWhat it does
--dry-runsay what it would fix, and change nothing.

Example: wordpress config repair, wordpress config repair --dry-run

wordpress runs

recorded runs — what this tool did, and when

wordpress runs list

recorded runs, newest first

wordpress runs list [query] [options]
ArgumentObligatoriedadWhat it is
queryoptionalfield:value terms that narrow the list — the fields are below.
OptionWhat it does
--limit <n>how many to show.
--page <n>which page, starting at 1.

Returns: run — run_id, command, started_at, status, cli_version, profile, completed_at, requests, and 23 more; every field: wordpress commands info runs list

Example: wordpress personal runs list --limit 10

wordpress runs show

one run: what it was, how it ended, and every event it logged

wordpress runs show <run-id> [options]
ArgumentObligatoriedadWhat it is
run-idrequiredan id from wordpress runs list.
OptionWhat it does
--problemsonly failed responses, warnings and crashes.

Returns: run details — run_id, command, started_at, status, cli_version, directory, event_count, events, and 22 more; every field: wordpress commands info runs show

Example: wordpress personal runs show run-101

wordpress runs path

the directory holding one run

wordpress runs path <run-id>
ArgumentObligatoriedadWhat it is
run-idrequiredan id from wordpress runs list.

Returns: run location — path; every field: wordpress commands info runs path

Example: wordpress personal runs path run-101

Códigos de salida

Branch on the code, not on the text: the text can change, the code does not.

CodeWhen
0it worked
2validation_error
3configuration_error
4authentication_error
5permission_error
6not_found
7confirmation_required
8rate_limited
9timeout
10network_error
11provider_error
12provider_unavailable
13invalid_response
14outcome_unknown
15conflict
130cancelled
1anything else