LumenJS provides a command-line interface for creating, developing, building, and serving projects.
Scaffold a new LumenJS project:
lumenjs create my-app
Creates a new directory with a ready-to-run project structure including pages/, lumenjs.config.ts, and package.json.
| Flag | Default | Description |
|---|---|---|
--template | default | Project template: default, blog, or dashboard |
lumenjs create my-blog --template blog
Start the development server with hot module replacement:
lumenjs dev
| Flag | Default | Description |
|---|---|---|
--project | . | Path to the project directory |
--port | 3000 | Dev server port |
--base | / | Base URL path (for subdirectory deployments) |
--editor-mode | off | Enable the visual editor overlay |
lumenjs dev --project ./my-app --port 4000 --base /app
Create a production build with separate client and server bundles:
lumenjs build
| Flag | Default | Description |
|---|---|---|
--project | . | Path to the project directory |
--out | .lumenjs | Output directory for the build |
The build produces three artifacts in the output directory:
.lumenjs/ ├── client/ # Static assets (JS, CSS, images) ├── server/ # SSR modules + API handlers └── manifest.json # Route manifest with loader/subscribe flags
Start the production server from a build output:
lumenjs serve
| Flag | Default | Description |
|---|---|---|
--project | . | Path to the project directory (must contain .lumenjs/) |
--port | 3000 | Server port |
lumenjs build --project ./my-app lumenjs serve --project ./my-app --port 8080
.lumenjs/ output.
Add an integration to your project:
lumenjs add tailwind
Integrations install dependencies and configure your project automatically. Available integrations include tailwind and nuralyui.
| Command | Description |
|---|---|
lumenjs create <name> | Scaffold a new project |
lumenjs dev | Start dev server with HMR |
lumenjs build | Production build (client + server) |
lumenjs serve | Serve production build |
lumenjs add <integration> | Add an integration |