CLI

create-next-app CLI 允许您快速创建一个新的 Next.js 应用,使用默认模板或来自公共 Github 仓库的 示例。这是开始使用 Next.js 最简单的方式。

基本用法:

终端
npx create-next-app@latest [项目名称] [选项]

参考

以下选项可用:

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

示例

使用默认模板

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

终端
npx create-next-app@latest

然后您将被询问以下问题:

终端
您的项目名称是?  my-app
是否使用 TypeScript?  否 / 是
是否使用 ESLint?  否 / 是
是否使用 Tailwind CSS?  否 / 是
是否将代码放在 `src/` 目录下?  否 / 是
是否使用应用路由 (App Router)?(推荐)  否 / 是
是否在 `next dev` 中使用 Turbopack?  否 / 是
是否自定义导入别名(默认为 `@/*`)?  否 / 是

回答完问题后,将根据您选择的配置创建一个新项目。

使用官方 Next.js 示例

要使用官方 Next.js 示例创建新应用,使用 --example 标志运行以下命令:

终端
npx create-next-app@latest --example [您的项目名称] [示例名称]

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

使用任意公共 Github 示例

要使用任意公共 Github 示例创建新应用,使用 --example 选项并指定 Github 仓库 URL。例如:

终端
npx create-next-app@latest --example [您的项目名称] "https://github.com/.../"

On this page