Chisel A WordPress Development Framework

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 6 or 8+ is required. Node 7 is not supported.

Yeoman & Chisel

Install Yeoman and Chisel globally. In your command line type:

npm install -g yo generator-chisel

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

npm install -g generator-chisel

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 you are on macOS, we recommend to install necessary packages with Homebrew according the following guides:

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

MySQL 8 authentication method not supported

If you happen to be using MySQL 8 with Chisel, you may encounter an error when trying to setup a project. mysqljs library used by Chisel doesn’t support default authentication method of MySQL 8 yet.

You can verify what method MySQL is using by running:

mysql -u root -p
USE mysql
SELECT host, user, plugin, authentication_string FROM user WHERE user='root';

If the result lists auth_socket, Chisel project setup won’t work. You can update authentication method by running the following commands:

ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY '[enter your password]';
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY ' [enter your password] ';

Alternative, switch to MariaDB or MySQL 5.

Problems with installation?

Submit an issue at GitHub with a label question or write us to the e-mail [email protected]. We are happy to help.

Craftsmanship and Work Ethics of Old Masters

Xfive - Developers who care

For more than a decade we’ve been helping creatives bring their visions to life in the digital world.

Xfive is a partner for design and web agencies looking to expand their capacity in web application development where care is the foundation of everything we do.

Work with us