Installation

The following software needs to be installed if you want to setup and develop projects with Chisel

These installations need to be done just once so you can skip this section if you have the software already installed.

Node.js

Install Node.js so you can work with npm, Node package manager. Version 10.14.2+ or 12+ is required.

Chisel

Install Chisel globally. In your command line type:

yarn global add generator-chisel@next
# or
npm -g install generator-chisel@next

If you want to update your existing Chisel installation to the latest version, also run:

yarn global add generator-chisel@next
# or
npm -g install generator-chisel@next

Apache, PHP, and MySQL

If you want to develop WordPress projects, you need to install Apache, PHP, and MySQL. The easiest option is to use development environments like MAMP or XAMPP. If using MAMP, check Allow network access to MySQL.

If you are on macOS, we recommend to install necessary packages with Homebrew according to the following guides:

macOS 11.0 Big Sur Apache Setup: Multiple PHP Versions - skip multiple PHP versions installation if you want
macOS 11.0 Big Sur Apache Setup: MySQL, Xdebug & More... - you can skip YAML and Xdebug installation

Known Issues

`mysql` or `mysqlcheck` not found

Chisel is using WP-CLI for most WP-related operations. WP-CLI is using mysql and mysqlcheck binaries, so check out if you have mysql and mysqlcheck binaries in your $PATH by running the following commands:

mysql --version
mysqlcheck --version

Problems with installation?

Submit an issue at GitHub with a label question or write us to the e-mail chisel@xfive.co. We are happy to help.