Skip to main content

Getting started

The WPCS CLI enables users to create CI/CD pipelines and locally develop Versions.

Authentication​

Many of the functionalities of the CLI rely on the WPCS API. This means that the CLI needs access to API keys. Check out the credentials article to authenticate the CLI.

Dependencies​

  • Node.js must be installed on your machine or server.
  • The WP CLI must be installed on your machine or server.

Using the CLI via npx​

Run npx @wpcs.io/cli check in your terminal. If everything is installed properly, you should see some output like this:

$ npx @wpcs.io/cli check

Success: all checks passed.