Quick Start

Use create-next-mui when you want a new Next.js App Router project with Material UI, theming, and optional tooling already arranged.

Prerequisites

Install Node.js and npm before running the CLI.

The current generated template uses Next.js 16.2.4, which requires Node.js >=20.9.0.

Create a Project

Run the CLI with npx:

npx create-next-mui@latest

You can also use npm init:

npm init next-mui@latest

The interactive setup asks for the project name, language, linter, optional features, and whether dependencies should be installed immediately.

Provide a Project Name

Pass the project name as the first argument when you already know the target folder:

npx create-next-mui@latest my-app

This creates a my-app directory and continues with the remaining prompts.

Use Defaults

Use --yes or -y to skip every prompt:

npx create-next-mui@latest my-app --yes

The default setup is:

To generate a JavaScript project in non-interactive mode, add --js:

npx create-next-mui@latest my-app --yes --js

--js only changes the default language when prompts are skipped.

Scaffold the Current Directory

Use . as the project name to create the app in the current folder:

npx create-next-mui@latest .

The current directory must be empty.

Run the App

Move into the generated project:

cd my-app

Install dependencies if you did not choose automatic install:

npm install

Start the development server:

npm run dev

Open http://localhost:3000 in your browser.

Add Features Later

Run feature installers from the root of an existing project:

npx create-next-mui@latest add react-query
npx create-next-mui@latest add zustand

After installing a feature, run npm install so the merged dependencies are available.