README

CLI to easily install and initialize Jigsaw sites with a single command

Installation

Install the CLI with Composer:

composer global require geoffselby/jigsaw-installer

Usage

To install and initialize a new site with Jigsaw:

jigsaw new my-site

This will install Jigsaw in a directory named my-site and initialize your Jigsaw site. It also initializes Git for you and creates an initial commit automatically.

Using starter templates

Jigsaw allows you to use a starter template when initializing a new site. You can choose between the two official starters (blog and docs) or any third-party starter on Packagist.

To use an official starter with this installer, use the --starter option:

jigsaw new my-site --starter blog

Or, to use a third-party starter, use the vendor/package syntax:

jigsaw new my-site --starter rickwest/jigsaw-clean-blog

Installing the development version

If you would like to install the development version of Jigsaw to test out new features before a stable release, use the --dev option:

jigsaw new my-site --dev

Install a specific version

In rare cases, you may need to install a specific version of Jigsaw. To do this, use the --v option:

jigsaw new my-site --v <version>

Don't initialize Git

If you don't want to initialize Git automatically, use the --no-git option:

jigsaw new my-site --no-git

License

Jigsaw Installer is open-sourced software licensed under the MIT license.

geoffselby / jigsaw-installer

Maintainers

Details