Template Docs

Create and run a ScreenUI template project in minutes.

Template CLI

Step-by-step guide to scaffold and run a ScreenUI template project.

Follow these steps to get your project running locally.

View all available templates before creating a project.

npx screenui-cli@latest list

Run the CLI command to scaffold a new project.

npx screenui-cli@latest create layout

Accept the default or enter a custom name.

? Project name: › layout
✔ Project name: … my-app

Allow the CLI to install dependencies.

? Install dependencies now? › Yes

Ensure installation completed successfully.

Dependencies installed successfully
Next:
  cd my-app
  npm run dev

Run the project locally.

cd my-app
npm run dev

Success

Your project is now running at http://localhost:3000