Overview
Example CLI is a command-line tool for packaging, previewing, and publishing static sites. It gives you a single command to go from a folder of files to a live URL, with sensible defaults and no configuration required to get started.
What it does
- Package — bundle your project into a deployable artifact.
- Preview — serve your site locally with live reload.
- Publish — push the artifact to a hosting target.
Who it's for
Anyone maintaining a static site or documentation set who wants a repeatable publish step without wiring up a build pipeline by hand.
New here? Head to
Getting Started to install the CLI
and publish your first site in a few minutes.
How it fits together
A typical project has a source folder, an optional config file, and a target. Example reads the source, produces an artifact, and hands it to the target you choose.
| Concept | Description |
|---|---|
| Source | The folder containing your site files. |
| Artifact | The packaged output Example produces. |
| Target | Where the artifact is published. |