caweb-cli

caweb-cli is a tool which rapidly sets up a local WordPress environment fully configured for the CAWebPublishing Service, allows for the creation of Gutenberg blocks with the CAWebPublishing template configurations, and much more. The cli will automatically generate the necessary .wp-env.json file, to override or add additional configuration options use the .wp-env.override.json file.

caweb-cli is largely inspired by WordPress Packages major thanks to the whole WordPress team and community!

Prerequisites

• Latest version of Docker Desktop, which includes Compose v2, is installed.
  • For Debian-Based Linux distributions: docker-compose may need to be installed with: sudo apt-get install docker-compose.
  • For Windows users: WSL should be set to version 2 for Windows Docker Desktop compatibility.
• git is installed.

Additional Features

• Downloads and configures the CAWeb Theme
• Downloads approved plugins utilized by the CAWebPublishing Service
• Downloads and configures the Divi Theme and Divi Builder Plugin (requires valid ElegantThemes Username and API Key)
• Adds phpMyAdmin Service for both WordPress environments. (Username: root , Password: password)
  • phpMyAdmin development site starts at http://localhost:8080
  • phpMyAdmin test site started at http://localhost:9090
• Uses CAWebPublishing External Project Template Configuration when creating Gutenberg Blocks, see configurations here
• Allows for syncing of WordPress instance via Rest API, to maintain ID's please ensure CAWebPublishing Development Toolbox plugin is installed.
• Adds config.yml to both cli containers.
  Example config.yml file

    path: /var/www/html
    apache_modules:
      - mod_rewrite

Command Reference

caweb start

Generates the required wp-env.json, starts the WordPress environment, downloads any CAWebPublishing sources and approved plugins.

caweb start [options]

Starts two CAWebPublishing WordPress instances
development on port 8888 (​http://localhost:8888​) (override with WP_ENV_PORT)
tests on port 8889 (​http://localhost:8889​) (override with WP_ENV_TESTS_PORT).
After first install, use the '--update' flag to download updates to mapped sources and to re-apply CAWeb configuration options.

Options:
  --bare           True if excluding any downloads from CAWeb, use this if you want to use a local version of the CAWeb Theme, Configurations will still be applied. (default: false)
  -h, --help       display help for command
  -m, --multisite  True if converting to multisite. (default: false)
  -p, --plugin     True if root directory is a plugin. (default: false)
  --scripts        Execute any configured lifecycle scripts. (default: true)
  --subdomain      If passed, the network will use subdomains, instead of subdirectories. Doesn't work with 'localhost', make sure to set Port to 80. (default: false)
  -t, --theme      True if root directory is a theme. (default: false)
  --update         Download source updates and apply WordPress configuration. (default: false)
  --xdebug   Enables Xdebug. If not passed, Xdebug is turned off. If no modes are set, uses "debug". You may set multiple Xdebug modes by passing them in a comma-separated list:
                   `--xdebug=develop,coverage`. See https://xdebug.org/docs/all_settings#mode for information about Xdebug modes.

caweb stop

caweb stop

Stops running WordPress for development and tests and frees the ports.

Options:
  --debug    Enable debug output.                     [boolean] [default: false]

caweb clean [environment]

caweb clean [environment]

Cleans the WordPress databases.

Positionals:
  environment  Which environments' databases to clean.
            [string] [choices: "all", "development", "tests"] [default: "tests"]

Options:
  --debug    Enable debug output.                     [boolean] [default: false]
  --scripts  Execute any configured lifecycle scripts. [boolean] [default: true]

caweb run <container> [command...]

caweb run <container> [command...]

Runs an arbitrary command in one of the underlying Docker containers. A double
dash can be used to pass arguments to the container without parsing them. This
is necessary if you are using an option that is defined below. You can use
`bash` to open a shell session and both `composer` and `phpunit` are available
in all WordPress and CLI containers. WP-CLI is also available in the CLI
containers.

Positionals:
  container  The underlying Docker service to run the command on.
              [string] [required] [choices: "mysql", "tests-mysql", "wordpress",
                                          "tests-wordpress", "cli", "tests-cli"]
  command    The command to run.                           [array] [default: []]

Options:
  --debug    Enable debug output.                     [boolean] [default: false]
  --env-cwd  The command's working directory inside of the container. Paths
             without a leading slash are relative to the WordPress root.
                                                         [string] [default: "."]

caweb destroy

caweb destroy

Destroy the WordPress environment. Deletes docker containers, volumes, and
networks associated with the WordPress environment and removes local files.

Options:
  --debug    Enable debug output.                     [boolean] [default: false]
  --scripts  Execute any configured lifecycle scripts. [boolean] [default: true]

caweb logs [environment]

caweb logs [environment]

displays PHP and Docker logs for given WordPress environment.

Positionals:
  environment  Which environment to display the logs from.
      [string] [choices: "development", "tests", "all"] [default: "development"]

Options:
  --debug    Enable debug output.                     [boolean] [default: false]
  --watch    Watch for logs as they happen.            [boolean] [default: true]

caweb install-path

caweb install-path

Get the path where all of the environment files are stored. This includes the
Docker files, WordPress, PHPUnit files, and any sources that were downloaded.

Options:
  --debug    Enable debug output.                     [boolean] [default: false]

caweb shell [environment]

caweb shell [environment]

Open shell terminal in WordPress environment.

Positionals:
  environment  Which environment to open terminal in.
             [string] [choices: "development", "tests"] [default: "development"]

Options:
  --debug    Enable debug output.                     [boolean] [default: false]

caweb update-plugins [environment]

caweb update-plugins [environment]

Updates all plugins in the WordPress environment.

Positionals:
  environment  Which environment to update.
             [string] [choices: "development", "tests"] [default: "development"]

Options:
  --debug    Enable debug output.                     [boolean] [default: false]

caweb create-block [options] <slug>

caweb create-block [options] <slug>

Scaffold for WordPress plugin to register CA.gov Design System Block.

Arguments:
  slug           Plugin slug to use.

Options:
  -h, --help     display help for command

caweb update-block [options] <slug>

caweb update-block [options] <slug>

Updates a CA.gov Design System Block.

Arguments:
  slug           Plugin slug to update.

Options:
  -h, --help     display help for command

caweb sync <from> <to>

In order for the sync process to work correctly, you must have a caweb.json file in the project root directory. For more information read caweb.json configuration.

caweb sync <from> <to>

Sync changes from one destination to another.

Arguments:
  from               Target Site URL with current changes.
  to                 Destination Site URL that should be synced.

Options:
  -h, --help         display help for command
  -t,--tax [tax...]  Taxonomy that should be synced. Omitting this option will sync the full site. (choices: "pages", "posts", "media", "menus")