Menu

create-next-app

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

基本用法：

Terminal
npx create-next-app@latest [project-name] [options]

参考

以下选项可用：

选项描述
-h 或 --help显示所有可用选项
-v 或 --version输出版本号
--no-*否定默认选项。例如 --no-ts
--ts 或 --typescript初始化为 TypeScript 项目（默认）
--js 或 --javascript初始化为 JavaScript 项目
--tailwind使用 Tailwind CSS 配置初始化（默认）
--react-compiler初始化并启用 React Compiler
--eslint使用 ESLint 配置初始化
--biome使用 Biome 配置初始化
--no-linter跳过 linter 配置
--app初始化为 App Router 项目
--api初始化一个仅包含 route handlers 的项目
--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 或 --example [name] [github-url]用于引导应用的示例
--example-path <path-to-example>单独指定示例的路径
--reset-preferences明确告诉 CLI 重置任何存储的偏好设置
--skip-install明确告诉 CLI 跳过安装包
--disable-git明确告诉 CLI 禁用 git 初始化
--yes对所有选项使用之前的偏好设置或默认值

示例

使用默认模板

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

Terminal
npx create-next-app@latest

在安装时，你会看到以下提示：

Terminal
What is your project named? my-app
Would you like to use the recommended Next.js defaults?
    Yes, use recommended defaults - TypeScript, ESLint, Tailwind CSS, App Router, Turbopack
    No, reuse previous settings
    No, customize settings - Choose your own preferences

如果你选择 customize settings，你会看到以下提示：

Terminal
Would you like to use TypeScript? No / Yes
Which linter would you like to use? ESLint / Biome / None
Would you like to use React Compiler? 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? (recommended) No / Yes
Would you like to customize the import alias (`@/*` by default)? No / Yes
What import alias would you like configured? @/*

在提示之后，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 标志。例如：

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

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

使用任何公共 GitHub 示例

要使用任何公共 GitHub 示例创建新应用，请使用 --example 选项并提供 GitHub 仓库的 URL。例如：

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