Documentation menu

WP-CLI reference

Every wp agentwarden command, generated from the source. Run wp help agentwarden <command> on a site for the same text.

wp agentwarden agents#

wp agentwarden agents list#

Lists agents.

OPTIONS

[--status=<status>] : Only agents with this status.

options:

  • active
  • paused
  • revoked

[--format=<format>] : Output format.

default: table options:

  • table
  • json
  • csv
  • yaml
  • ids
  • count

wp agentwarden agents create#

Creates an agent with a policy from a template and prints its token once.

OPTIONS

--name=<name> : Agent name.

[--template=<template>] : Policy template ID. Defaults to the read-only auditor.

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

[--owner=<user>] : Owner's ID, login, or email. Defaults to the WP-CLI user.

[--porcelain] : Print only the token.

wp agentwarden agents pause#

Pauses agents.

OPTIONS

<id>... : Agent IDs.

wp agentwarden agents resume#

Resumes paused agents.

OPTIONS

<id>... : Agent IDs.

wp agentwarden agents revoke#

Revokes agents and all their tokens. Cannot be undone.

OPTIONS

<id>... : Agent IDs.

[--yes] : Do not ask for confirmation.

wp agentwarden policy#

wp agentwarden policy export#

Exports an agent's policy document as JSON.

OPTIONS

<agent> : Agent ID.

[--version=<version>] : Policy version. Defaults to the latest.

[--file=<path>] : Write to a file instead of standard output.

wp agentwarden policy import#

Saves a policy document as the agent's next version.

OPTIONS

<agent> : Agent ID.

[<file>] : JSON file. Reads standard input when omitted.

[--base-version=<version>] : Refuse the import if the agent's policy changed after this version.

wp agentwarden log#

wp agentwarden log export#

Exports the action log, oldest first.

OPTIONS

[--format=<format>] : Export format.

default: csv options:

  • csv
  • json
  • jsonl

[--agent=<id>] : Only this agent.

[--ability=<name>] : Only this ability.

[--decision=<decision>] : Only this decision, e.g. allow, deny, hold, or simulate.

[--from=<date>] : First day, YYYY-MM-DD (UTC).

[--to=<date>] : Last day, YYYY-MM-DD (UTC).

[--file=<path>] : Write to a file instead of standard output.

wp agentwarden log verify#

Checks the action log's hash chain and signed checkpoints (ADR-0037 §5).

Exits with status 1 when the log was tampered with, so it can run from a monitoring job.

OPTIONS

[--format=<format>] : Output format.

default: table options:

  • table
  • json

wp agentwarden log checkpoint#

Seals waiting log rows and records a signed checkpoint now, instead of waiting for the daily one.

wp agentwarden siem#

wp agentwarden siem status#

Shows each SIEM destination: whether it is on, what was delivered, what is waiting, and the last error.

OPTIONS

[--format=<format>] : Output format.

default: table options:

  • table
  • json
  • csv
  • yaml

wp agentwarden siem push#

Pushes waiting sealed rows and checkpoints to every enabled destination now.

Exits with status 1 when any destination failed.

wp agentwarden compliance#

wp agentwarden compliance report#

Generates a signed compliance report for a quarter.

OPTIONS

--quarter=<quarter> : A quarter that has ended, such as 2026-Q3.

[--output=<file>] : Write the signed JSON to this file instead of printing it.

EXAMPLES

wp agentwarden compliance report --quarter=2026-Q3 --output=agentwarden-2026-Q3.json

wp agentwarden compliance verify#

Verifies the signature of a compliance report file.

Exits with status 1 when the signature does not match.

OPTIONS

<file> : Signed report JSON.

wp agentwarden retention#

wp agentwarden retention status#

Shows the retention period in force and whether a legal hold is on.

OPTIONS

[--format=<format>] : Output format.

default: table options:

  • table
  • json
  • csv
  • yaml

wp agentwarden retention set#

Sets the Enterprise retention period.

OPTIONS

<days> : Days from 30 to 3650, or default for the plan's period.

EXAMPLES

wp agentwarden retention set 2555
wp agentwarden retention set default

wp agentwarden retention hold#

Places a legal hold: no agent history is deleted until it is released.

OPTIONS

--reason=<reason> : Why the hold is placed. Recorded in the action log.

wp agentwarden retention release#

Releases the legal hold; retention applies again at the next prune.

OPTIONS

--reason=<reason> : Why the hold is released. Recorded in the action log.

wp agentwarden lockdown#

wp agentwarden lockdown status#

Shows each lock, whether it is saved, and whether it is in force on this site's plan.

OPTIONS

[--format=<format>] : Output format.

default: table options:

  • table
  • json
  • csv
  • yaml

EXAMPLES

wp agentwarden lockdown status

wp agentwarden undo#

wp agentwarden undo session#

Undoes everything an agent session changed.

Shows a preview and stops unless --yes is given.

OPTIONS

<session> : Session ID.

[--resolve=<resolutions>] : Conflict resolutions as entry:keep, entry:restore, or entry:skip, comma-separated.

[--yes] : Run the undo instead of previewing it.

wp agentwarden pause-all#

A single command. Run wp help agentwarden pause-all for its options.

wp agentwarden resume-all#

A single command. Run wp help agentwarden resume-all for its options.