create-next-app
开始使用 Next.js 最简单的方式是使用 create-next-app
。这个命令行工具能让你快速搭建新的 Next.js 应用,并自动完成所有基础配置。
你可以使用默认的 Next.js 模板创建新应用,也可以选择 Next.js 官方示例 中的模板。
交互式创建
通过以下命令以交互方式创建新项目:
npx create-next-app@latest
yarn create next-app
pnpm create next-app
bunx create-next-app
随后会提示以下选项:
请输入项目名称? my-app
是否使用 TypeScript? 否 / 是
是否使用 ESLint? 否 / 是
是否使用 Tailwind CSS? 否 / 是
是否使用 `src/` 目录? 否 / 是
是否使用 App 路由?(推荐) 否 / 是
是否自定义默认导入别名 (@/*)? 否 / 是
完成选择后,系统会根据你的回答自动创建配置正确的新项目。
非交互式创建
你也可以通过命令行参数直接创建项目(无需交互问答)。
此外,可以通过 --no-
前缀取消默认选项(例如 --no-eslint
)。
查看 create-next-app --help
:
用法: create-next-app <项目目录> [选项]
选项:
-V, --version 输出版本号
--ts, --typescript
初始化为 TypeScript 项目(默认值)
--js, --javascript
初始化为 JavaScript 项目
--tailwind
初始化包含 Tailwind CSS 配置(默认值)
--eslint
初始化包含 ESLint 配置
--app
初始化为 App 路由项目
--src-dir
在 `src/` 目录内初始化项目
--import-alias <配置别名>
指定导入别名(默认为 "@/*")
--use-npm
明确告知 CLI 使用 npm 初始化应用
--use-pnpm
明确告知 CLI 使用 pnpm 初始化应用
--use-yarn
明确告知 CLI 使用 Yarn 初始化应用
--use-bun
明确告知 CLI 使用 Bun 初始化应用
-e, --example [名称]|[github-url]
基于示例初始化应用。可使用 Next.js 官方仓库中的示例名称
或公开 GitHub 仓库 URL。URL 可包含任意分支和/或子目录
--example-path <示例路径>
极少数情况下,你的 GitHub URL 可能包含带斜杠的分支名称
(如 bug/fix-1)和示例路径(如 foo/bar)。
此时必须单独指定示例路径:
--example-path foo/bar
--reset-preferences
明确告知 CLI 重置所有存储的首选项
-h, --help 输出使用信息
为什么使用 Create Next App?
create-next-app
让你能在几秒内创建新的 Next.js 应用。该工具由 Next.js 官方团队维护,具有以下优势:
- 交互式体验:直接运行
npx create-next-app@latest
(不带参数)会启动交互式向导,引导你完成项目配置 - 零依赖:初始化项目最快仅需一秒。Create Next App 本身没有任何依赖
- 离线支持:当检测到离线状态时,Create Next App 会自动使用本地包缓存初始化项目
- 示例支持:可以从 Next.js 示例集合(如
npx create-next-app --example api-routes
)或任意公开 GitHub 仓库初始化项目 - 经过测试:该工具是 Next.js 单体仓库的一部分,使用与 Next.js 相同的集成测试套件进行验证,确保每个版本都能正常工作