Skip to content

cwp roles pull

shipped 1.0.0
cwp roles pull [env] [flags]

This name is an alias. The work moved to cwp pull --only roles, and that page documents it. This spelling still runs for one minor cycle.

Acts on the local site. Name an environment to act there instead.

tree ← site

ArgumentWhat it isDefault
[env]environment to read (default: default_environment in cwp.yml)
FlagWhat it doesDefault
--with-agentwith —dry-run on a host with no shell: install and remove the PHP agent so the plan is realoff

Plus the shared flags --json, -v, --verbose, -q, --quiet and --dry-run.

What it does

Reads every role and its capabilities from a site into the tree, as roles.yml.

The file records granted and explicitly-denied capabilities apart. WordPress distinguishes “not granted” from “granted false”. A denied: list appears only when a role has one.

What it does not do

  • It does not write when nothing changed, so a pull that found nothing new leaves the git tree clean.
  • It records no user, no user count, and no assignment of roles to people.
  • It touches nothing on the site.