Installing a Starter Kit

Installing a Starter Kit is a pretty simple thing, but like with many things in life, there are a few different ways you can do it. Let's cover them all.

Read This First

Most (but not all) Starter Kits are intended to be used in a brand new, empty site. Be sure to read each kit's documentation before installing into an existing site so you know what to expect and how to get the most out of it.

Installing from the Command Line

You can spin up a new install of Statamic along with a Starter Kit at the all in one command by using the Statamic CLI Tool:

statamic new my-site vendor/starter-kit

You can alternatively install a Starter Kit into an existing site by running the following command while inside that install's root directory:

php please starter-kit:install vendor-name/starter-kit-name

If you are installing a paid Starter Kit, you will be prompted to purchase and/or validate a single-use license. Once successfully installed, this license will be marked as used and cannot be used on future Statamic sites.

When To Clear Your Site First

If you are installing into a fresh Statamic installation (a pre-built site, for example), you may wish to clear your site of any sample or placeholder content first.

If you are installing a more modular or functionality-driven type Starter Kit into an existing Statamic site (like an icon set or e-commerce checkout), you will want to skip this step!

The installer will ask you if you wish to clear your site first, but you can also force clear by running with the --clear-site install option.

Installing Without Dependencies

If you wish to install without bundled dependencies, you can run with the --without-dependencies install option.

Docs feedback

Submit improvements, related content, or suggestions through Github.

Betterify this page →