Menu

create-next-app

create-next-app CLI 允许你使用默认模板或从公共 GitHub 仓库中的示例创建新的 Next.js 应用。这是开始使用 Next.js 最简单的方式。

基本用法:

Terminal
npx create-next-app@latest [project-name] [options]

参考

以下是可用的选项:

选项说明
-h--help显示所有可用选项
-v--version输出版本号
--no-*否定默认选项。例如 --no-eslint
--ts--typescript初始化为 TypeScript 项目(默认)
--js--javascript初始化为 JavaScript 项目
--tailwind初始化 Tailwind CSS 配置(默认)
--eslint初始化 ESLint 配置
--app初始化为 App 路由项目
--src-dirsrc/ 目录中初始化
--turbopack默认启用 Turbopack 进行开发
--import-alias <alias-to-configure>指定要使用的导入别名(默认为 "@/*")
--empty初始化一个空项目
--use-npm明确告诉 CLI 使用 npm 引导应用
--use-pnpm明确告诉 CLI 使用 pnpm 引导应用
--use-yarn明确告诉 CLI 使用 Yarn 引导应用
--use-bun明确告诉 CLI 使用 Bun 引导应用
-e--example [name] [github-url]用于引导应用的示例
--example-path <path-to-example>单独指定示例的路径
--reset-preferences明确告诉 CLI 重置所有已存储的偏好设置
--skip-install明确告诉 CLI 跳过安装包
--yes对所有选项使用之前的偏好设置或默认值

示例

使用默认模板

要使用默认模板创建新应用,在终端中运行以下命令:

Terminal
npx create-next-app@latest

然后你会看到以下提示:

Terminal
What is your project named?  my-app
Would you like to use TypeScript?  No / Yes
Would you like to use ESLint?  No / Yes
Would you like to use Tailwind CSS?  No / Yes
Would you like your code inside a `src/` directory?  No / Yes
Would you like to use App Router? (recommended)  No / Yes
Would you like to use Turbopack for `next dev`?  No / Yes
Would you like to customize the import alias (`@/*` by default)?  No / Yes

回答完这些提示后,将会使用你选择的配置创建一个新项目。

使用官方 Next.js 示例

要使用官方 Next.js 示例创建新应用,使用 --example 标志。例如:

Terminal
npx create-next-app@latest --example [example-name] [your-project-name]

你可以在 Next.js 仓库中查看所有可用示例的列表以及设置说明。

使用任何公共 GitHub 示例

要使用任何公共 GitHub 示例创建新应用,使用 --example 选项和 GitHub 仓库的 URL。例如:

Terminal
npx create-next-app@latest --example "https://github.com/.../" [your-project-name]