Options

Learn about the supported commands, arguments, and flags available in create-next-mui.

The CLI provides a small set of commands and flags to help you scaffold projects faster or extend existing ones with official plugins.

Project Name

Provide a project name to create a new application.

npx create-next-mui@latest <project-name>

npx create-next-mui@latest my-app

This creates a new project inside the my-app directory.

Current Directory

Use . as the project name to scaffold the project in the current working directory.

npx create-next-mui@latest .

Make sure the directory is empty before running the command.

Install an official plugin into an existing project.

npx create-next-mui@latest add <plugin-name>

Install Zustand.

npx create-next-mui@latest add zustand

Install TanStack Query.

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

Supported plugins are documented in the Plugins section.

Choose the language that best fits your project during the interactive setup.

Template	Description
TypeScript	Recommended for most projects. Includes strict typing and an improved developer experience.
JavaScript	A lightweight option for developers who prefer JavaScript.

Official plugins can be installed at any time after your project has been created.

A lightweight state management library for React applications.

Recommended when your application requires shared or complex client-side state.

Formerly known as React Query.

Provides powerful tools for:

Skips all interactive prompts and generates the project using the default configuration.

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

Short alias for --yes.

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

These flags are especially useful for: