跳至内容
API 参考CLICLI

CLI

create-next-app CLI 允许您使用默认模板或来自公共 GitHub 存储库的示例创建新的 Next.js 应用程序。这是开始使用 Next.js 的最简单方法。

基本用法

终端
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-dir在 src/ 目录内初始化
--turbo默认情况下为开发启用 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对所有选项使用先前首选项或默认值

示例

使用默认模板

要使用默认模板创建新应用，请在您的终端中运行以下命令

终端
npx create-next-app@latest

然后会提示您进行以下操作

终端
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 标志。例如

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

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

使用任何公共 GitHub 示例

要使用任何公共 GitHub 示例创建新应用，请使用带有 GitHub 存储库 URL 的 --example 选项。例如

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