Get started

Installation

Install the Velu CLI and learn the commands you'll use day to day.

The Velu CLI scaffolds a new project and runs a local preview server. It's published on npm as @veluai/velu.

Install

Check Node.js

Velu needs Node.js 18 or newer. Check your version:

node --version

If you don't have it, install it from nodejs.org.

Install the CLI

Install globally to use the velu command anywhere:

npm i -g @veluai/velu

Or skip the install and run any command on demand with npx @veluai/velu.

Verify

velu --version

Commands

The CLI has two commands: one to create a project and one to preview it.

Command	What it does
`velu init <name>`	Scaffold a new project into `./<name>` with a starter theme and example pages.
`velu dev [dir]`	Start the local preview server with live reload. Defaults to the current folder.

Building and hosting your production site is handled by Velu's platform, not the local CLI. Use velu dev to preview locally, then publish through the dashboard.

Keep the CLI current

Running with npx @veluai/velu always fetches the latest published version. If you installed globally, update with npm:

npm i -g @veluai/velu@latest

Next step

Local development

Start the dev server and preview your site with live reload as you write.

Preview locally

Was this page helpful?

Quickstart

Local development