What cwp can do lists the actions. This page lists what each
one writes: the individual steps a run performs, one line each.
These are the same names the tool prints. A step here is an entry in the
plan a command builds before it touches anything. --dry-run shows you this
list narrowed to your project, and the run reports against it. Nothing a
command does is missing from its plan. An operation that performs a step it
did not declare is a defect, and cwp reports it instead of going on.
Angle brackets are the parts your project fills in: <n> a count, <env>
the environment you named, <path> a file in your tree. A step is shown at
its fullest. The optional halves of a line appear here, and a run that has
nothing to put in them leaves them out.
cwp reads this page from the effects in the source. The code declares 60
steps, and the page has that many.
cwp ability
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
call <name> | either | no | run stops |
cwp adopt
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
record the adoption on the site | either | no | run stops |
adopt <post> | either | no | run stops |
remove cwp's identity and records (<tracked> item(s) still tracked) | either | yes | run stops |
cwp bricks post-types
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
<change> the builder for "<slug>" on <env> | either | no | run stops |
cwp edge captcha
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
captcha <kind>: provision and write keys | named environment | no | run stops |
cwp edge pull
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
read the edge down into <edge artifact path> | your tree | no | run stops |
cwp edge push
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
edge: <n> setting(s) | named environment | no | run stops |
cwp fetch
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
<kind>/<name> | local site | no | run stops |
cwp launch
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
set the stage to live | your tree | no | run stops |
cwp mcp
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
mint the application password "<password name>" on <env> | either | yes | run stops |
cwp perimeter
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
site: <current site> → <wanted site> | either | no | run stops |
<door>: <value> (edge) | named environment | no | run stops |
measures (edge) | named environment | no | run stops |
cwp pull
The command page has the flags and an example.
cwp pull
| Step | Writes to | Destructive | If it fails |
|---|
read <name> down from <env> | your tree | no | run stops |
capture the files the content points at from "<env>" | your tree | no | run continues |
post-import steps | local site | no | run continues |
cwp pull --only content
| Step | Writes to | Destructive | If it fails |
|---|
write <path> | your tree | no | run stops |
adopt <type>/<slug> | either | no | run stops |
mark <n> term(s) and menu(s) on <env> | either | no | run stops |
keep <dir>/ | your tree | no | run stops |
cwp push
The command page has the flags and an example.
cwp push
| Step | Writes to | Destructive | If it fails |
|---|
deploy post-steps on <env> | named environment | no | run continues |
settle the builder after the content landed | either | no | run continues |
push <tracked> | named environment | no | run stops |
file-level diff | named environment | no | run continues |
cwp push --only bricks
| Step | Writes to | Destructive | If it fails |
|---|
import <n> design-system item(s) | either | no | run stops |
set the site-wide options the design system carries (<name>) | either | no | run stops |
remove superseded font binaries | either | no | run continues |
remove <n> design-system item(s) the tree no longer describes | either | no | run stops |
cwp push --only content
| Step | Writes to | Destructive | If it fails |
|---|
create user <login> on <env> | either | no | run stops |
upload <path> | either | no | run stops |
update <n> field(s) on <n> attachment(s) | either | no | run stops |
write <n> menu(s) | either | depends | run stops |
record this run on <env>, with its dashboard widget | named environment | no | run continues |
upsert <n> term(s) | either | no | run stops |
trash <n> post(s) the tree no longer describes | either | yes | run stops |
create <type>/<slug> | either | no | run stops |
update <type>/<slug> (#<id>) | either | depends | run stops |
cwp push --only inventory
| Step | Writes to | Destructive | If it fails |
|---|
install <type> <name> <wanted> (active) from <source> | either | depends | run continues |
<type> <name>: <present> → <wanted> | either | depends | run continues |
switch the site to <name> (from <present>) | either | depends | run continues |
activate <type> <name> | either | depends | run continues |
deactivate <type> <name> | either | depends | run continues |
DELETE <type> <name> | either | depends | run continues |
update WordPress <present> → at least <wanted> | either | depends | run continues |
update the WordPress database | either | depends | run continues |
upload <recorded> to <env> | named environment | no | run continues |
remove the staged copy of <recorded> | named environment | no | run continues |
cwp push --only roles
| Step | Writes to | Destructive | If it fails |
|---|
<n> role change(s) | either | depends | run stops |
cwp push --only settings
| Step | Writes to | Destructive | If it fails |
|---|
<name>: <n> option(s) | either | no | run stops |
| Step | Writes to | Destructive | If it fails |
|---|
<area>: <n> widget(s) | either | yes | run stops |
cwp scrub
The command page has the flags and an example.
| Step | Writes to | Destructive | If it fails |
|---|
mail guard | local site | yes | run stops |
anonymise users | local site | yes | run stops |
truncate log tables | local site | yes | run continues |
delete log posts | local site | yes | run stops |
delete transients | local site | yes | run continues |
blog_public = 0 | local site | yes | run continues |
Steps every operation can take
| Step | Writes to | Destructive | If it fails |
|---|
settle <family>: <describe settle> | either | no | run stops |
record the baseline for "<env>" | your tree | no | run stops |
Reading the columns
Writes to: your tree is a file in your repository and no site at all.
local site is the environment cwp init writes into
cwp.yml under that name, the copy on this machine.
named environment is the one you put on the command line. either means
the step is one or the other. It depends on whether you named an
environment; the plan decides that before it runs and prints it in the
confirmation.
Destructive: whether the step can discard something that was there. The
confirmation names a destructive step rather than counting it. depends
means the answer is a property of the run. An update that overwrites an
edit somebody made on the site is destructive. The same update against an
untouched post is not.
If it fails: whether the run ends there or carries on. run stops
leaves everything after that step undone. run continues reports the
failure, finishes the rest and still ends non-zero. cwp names the steps
that would stop it before it starts.