NNext.js 中文网 GitHub

create-next-app CLI

使用 create-next-app CLI 通过一条命令创建 Next.js 应用。

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

基本用法:

bash · pnpm
pnpm create next-app [project-name] [options]
bash · npm
npx create-next-app@latest [project-name] [options]
bash · yarn
yarn create next-app [project-name] [options]
bash · bun
bun create next-app [project-name] [options]

参考#

可使用以下选项:

选项描述
-h or --help显示所有可用选项
-v or --version输出版本号
--no-*否定默认选项。例如 --no-ts
--ts or --typescript初始化为 TypeScript 项目(默认)
--js or --javascript初始化为 JavaScript 项目
--tailwind使用 Tailwind CSS 配置初始化(默认)
--react-compiler初始化并启用 React Compiler
--cache-components初始化并启用 Cache Components(App Router 默认)
--eslint使用 ESLint 配置初始化
--biome使用 Biome 配置初始化
--no-linter跳过 linter 配置
--app初始化为 App Router 项目
--api初始化一个仅包含 Route Handler 的项目
--src-dir在 src/ 目录内初始化
--turbopack在生成的 package.json 中强制启用 Turbopack(默认启用)
--webpack在生成的 package.json 中强制启用 Webpack
--import-alias <alias-to-configure>指定要使用的导入别名(默认 "@/\*")
--empty初始化一个空项目
--use-npm明确告知 CLI 使用 npm 引导应用
--use-pnpm明确告知 CLI 使用 pnpm 引导应用
--use-yarn明确告知 CLI 使用 Yarn 引导应用
--use-bun明确告知 CLI 使用 Bun 引导应用
-e or --example [name] [github-url]用于引导应用的示例
--example-path <path-to-example>单独指定示例的路径
--reset-preferences明确告知 CLI 重置任何已存储的首选项
--skip-install明确告知 CLI 跳过安装包
--disable-git明确告知 CLI 禁用 git 初始化
--agents-md包含 AGENTS.md 以指导编码 agent(默认)
--agent-feedback准备匿名化的 Next.js 反馈供你审阅
--no-agent-feedback不准备匿名化的 Next.js 反馈供你审阅
--yes对所有选项使用先前的首选项或默认值

示例#

使用默认模板#

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

bash · pnpm
pnpm create next-app
bash · npm
npx create-next-app@latest
bash · yarn
yarn create next-app
bash · bun
bun create next-app

在安装过程中,你会看到以下提示:

Terminal
你的项目叫什么名字?my-app
是否使用推荐的 Next.js 默认配置?
    是,使用推荐默认配置 - TypeScript、ESLint、不使用 React Compiler、Tailwind CSS、不使用 src/ 目录、Cache Components、AGENTS.md、智能体反馈
    否,复用之前的设置
    否,自定义设置 - 选择你自己的偏好

如果你选择“自定义设置”,你会看到以下提示:

Terminal
你是否使用 TypeScript?否 / 是
你想使用哪个 linter?ESLint / Biome / 无
你是否使用 React Compiler?否 / 是
你是否使用 Tailwind CSS?否 / 是
你是否将代码放在 `src/` 目录中?否 / 是
你是否使用 Cache Components?否 / 是
你是否自定义导入别名(默认为 `@/*`)?否 / 是
你想配置什么导入别名?@/*
是否包含 AGENTS.md 以引导编程智能体编写最新的 Next.js 代码?否 / 是
你是否希望让智能体准备匿名反馈供你在编码时审阅,以帮助改进 Next.js?(可随时通过 `experimental.agentFeedback: false` 禁用。)否 / 是

在提示之后,create-next-app 将创建一个以你的项目命名的文件夹,并安装所需的依赖项。

Linter 选项#

ESLint:传统且最流行的 JavaScript linter。包含来自 @next/eslint-plugin-next 的 Next.js 专用规则。

Biome:一个快速、现代的 linter 和格式化工具,结合了 ESLint 和 Prettier 的功能。内置 Next.js 和 React 领域支持,以获得最佳性能。

None:完全跳过 linter 配置。你可以随时在之后添加 linter。

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

使用官方 Next.js 示例#

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

bash · pnpm
pnpm create next-app --example [example-name] [your-project-name]
bash · npm
npx create-next-app@latest --example [example-name] [your-project-name]
bash · yarn
yarn create next-app --example [example-name] [your-project-name]
bash · bun
bun create next-app --example [example-name] [your-project-name]

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

使用任意公共 GitHub 示例#

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

bash · pnpm
pnpm create next-app --example "https://github.com/.../" [your-project-name]
bash · npm
npx create-next-app@latest --example "https://github.com/.../" [your-project-name]
bash · yarn
yarn create next-app --example "https://github.com/.../" [your-project-name]
bash · bun
bun create next-app --example "https://github.com/.../" [your-project-name]
Next.js 中文网