Awaken Docs

Scaffold modern UIs instantly with the Awaken CLI and ready-made ScreenUI templates.

ScreenUI CLI Setup Guide

Follow these steps to create and run your first ScreenUI layout project.

List Available Templates

Before creating a project, view the list of available templates. Currently, only the Next.js layout template is available, but React TypeScript templates will appear here once added.

npx screenui list

Run CLI Command

Use the ScreenUI CLI to create a new project using an available template. For example, use the layout template.

npx screenui create layout

Enter Project Name

When prompted, you can rename your project or press Enter to use the default name. Example below shows renaming from "layout" to "test".

? Project name: › layout
✔ Project name: … test

Install Dependencies

After project creation, you’ll be asked whether to install dependencies automatically. Choose "Yes" to continue.

? Would you like to install dependencies now? Yes

Verify Successful Setup

Once installation completes, the CLI confirms success and shows next steps.

Dependencies installed successfully
Project "test" created successfully!
Next steps:
  cd test
  npm run dev

Start the Project

Navigate into your project folder and start the local development server.

cd test
npm run dev

Success!

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