In simple terms

What is Chisel?

Chisel is like an automatic coffee machine which can produce different types of coffees. When you get Chisel (i.e., when you install it on your computer), you can set up different types of projects with it, namely WordPress projects or static websites.

How do I work with Chisel?

Chisel doesn't have any shiny buttons to press, it is controlled from the command line. The basic command is chisel create. You typically run it in an empty folder where you want to set up your new project.

How does Chisel know what kind of coffee... er, project, I want?

When you run it, it will ask you a few questions, like what project type you want to set up, among others.

How does Chisel create my project files?

Like a coffee machine with different types of coffees or other ingredients in it, Chisel is installed in your computer with ingredients for your project. These are templates of various project files. Depending on your answers during the project setup, it takes some of these templates, customizes them, and creates new project files from them.

Why does Chisel install something for the project yet?

Each project set up with Chisel comes with a bunch of useful tools to automate common web development tasks like browser reloading, CSS minification, etc. The exact list of these tools depends on your project type and answers during the setup and is stored in the file called package.json. So when Chisel ends setting up your project files, it will take a look at the list of these tools and installs them.

Can I change the project type when it's already setup?

No, when you got your espresso or latte, you cannot put it back in the machine to make it something different. However, if you know what you are doing, you could improve it, maybe with a bit of milk or cinnamon.

Similarly, once Chisel sets up the project, you cannot change the project type. You could do some customization to the project by adding new tools to it or customizing the existing ones, but it's not something you usually have to do. Chisel produces delicious projects out-of-box.

I've got a Chisel project from a developer and I'd like to continue working on that. What should I do?

1. First, install Chisel
2. Next, set up a project:
   • WordPress project - scroll down to Setting up an existing project
   • Static project - scroll down to Setting up an existing project
3. If you have trouble installing Chisel or setting up a project, submit an issue at GitHub with a label question or write us to the e-mail chisel@xfive.co. We are happy to help.

I've got a Chisel project from a developer, but I'm a fan of good old CSS and HTML

The good old HTML & CSS, who wouldn't like those, right? However, we recommend that you give Chisel a chance, install it, and setup the existing project so you can use the power and flexibility of modern development workflow. See the previous question for how to do that.

If you still would like to work with CSS and HTML directly, they are stored in the dist folder. Chisel automatically creates unminified CSS, the file name looks somewhat like main.6a889b04.full.css. Unfortunately, there is no reasonable way how to work with JavaScript files in the dist folder directly.

Beware, once you edit HTML or CSS in the dist folder, you or other developers shouldn't use standard project workflow and tasks anymore. The standard development workflow overrides the content of the dist folder so you could lose your changes.

For the full overview and comparison of old school vs. modern development workflow check out this article.

What if I have a problem with the Chisel installation or Chisel project?

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