create-next-app 命令行工具

create-next-app 命令行工具允许您使用默认模板或从公共 GitHub 仓库的 示例 创建新的 Next.js 应用。这是开始使用 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初始化为应用路由项目
--api初始化仅包含路由处理器的项目
--src-dirsrc/ 目录内初始化
--turbopack默认启用 Turbopack 进行开发
--import-alias <配置的别名>指定要使用的导入别名(默认为 "@/*")
--empty初始化空项目
--use-npm明确告知 CLI 使用 npm 初始化应用
--use-pnpm明确告知 CLI 使用 pnpm 初始化应用
--use-yarn明确告知 CLI 使用 Yarn 初始化应用
--use-bun明确告知 CLI 使用 Bun 初始化应用
-e--example [名称] [GitHub地址]用于初始化应用的示例
--example-path <示例路径>单独指定示例路径
--reset-preferences明确告知 CLI 重置所有存储的偏好设置
--skip-install明确告知 CLI 跳过安装软件包
--yes对所有选项使用先前的偏好设置或默认值

示例

使用默认模板

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

终端
npx create-next-app@latest

随后您将看到以下提示:

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

回答完提示后,将根据您的选择创建新项目。

使用官方 Next.js 示例

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

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

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

使用任意公共 GitHub 示例

要使用任意公共 GitHub 示例创建新应用,请结合 GitHub 仓库地址使用 --example 选项。例如:

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

On this page