Getting Started

This guide takes you from install to your first published site.

1. Install

Install the CLI with your package manager of choice:

npm install -g example-cli

Verify the install:

example --version

2. Create a project

Scaffold a new project in the current directory:

example init my-site
cd my-site

3. Preview locally

Start the local dev server with live reload:

example preview

Open http://localhost:4000 to see your site.

Changes to files in the source folder reload the browser automatically. No restart needed.

4. Publish

Package and publish to your configured target:

example publish

Heads up: the first publish creates the target if it doesn't exist. Double-check the target name in example.config.json before running this in a shared account.

Next steps

Hit a snag? See Troubleshooting.
Common questions are answered in the FAQ.