create-next-app CLI 允许您使用默认模板或公共 GitHub 仓库中的一个 示例 来创建一个新的 Next.js 应用程序。这是开始使用 Next.js 最简单的方法。
基本用法:
npx create-next-app@latest [project-name] [options]以下选项可用:
| Options | Description |
|---|---|
-h or --help | 显示所有可用选项 |
-v or --version | 输出版本号 |
--no-* | 禁用默认选项。例如 --no-ts |
--ts or --typescript | 初始化为 TypeScript 项目(默认) |
--js or --javascript | 初始化为 JavaScript 项目 |
--tailwind | 初始化时包含 Tailwind CSS 配置(默认) |
--react-compiler | 初始化时启用 React Compiler |
--eslint | 初始化时包含 ESLint 配置 |
--biome | 初始化时包含 Biome 配置 |
--no-linter | 跳过 linter 配置 |
--app | 初始化为 App Router 项目 |
--api | 仅使用路由处理程序初始化项目 |
--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 初始化 |
--yes | 对所有选项使用先前的偏好设置或默认值 |
要使用默认模板创建新应用程序,请在终端中运行以下命令:
npx create-next-app@latest安装时,您将看到以下提示:
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,您将看到以下提示:
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 customize the import alias (`@/*` by default)? No / Yes
What import alias would you like configured? @/*在提示之后,create-next-app 将创建一个以您的项目名称命名的文件夹并安装所需的依赖项。
ESLint:传统且最流行的 JavaScript linter。包含来自 @next/eslint-plugin-next 的 Next.js 特定规则。
Biome:一个快速、现代的 linter 和格式化工具,结合了 ESLint 和 Prettier 的功能。包含内置的 Next.js 和 React 领域支持,以实现最佳性能。
None:完全跳过 linter 配置。您可以随时稍后添加 linter。
一旦您回答了提示,将根据您选择的配置创建一个新项目。
要使用官方 Next.js 示例创建新应用程序,请使用 --example 标志。例如:
npx create-next-app@latest --example [example-name] [your-project-name]您可以在 Next.js 仓库 中查看所有可用示例列表以及设置说明。
要使用任何公共 GitHub 示例创建新应用程序,请使用 --example 选项并提供 GitHub 仓库的 URL。例如:
npx create-next-app@latest --example "https://github.com/.../" [your-project-name]