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

Command Reference

caweb start

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

caweb stop

caweb clean [environment]

caweb run <container> [command...]

caweb destroy

caweb logs [environment]

caweb install-path

caweb shell [environment]

caweb update-plugins [environment]

caweb create-block [options] <slug>

caweb update-block [options] <slug>

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.