create-next-app
create-next-app
CLI 允许您快速创建一个新的 Next.js 应用,使用默认模板或来自公共 Github 仓库的 示例。这是开始使用 Next.js 最简单的方式。
基本用法:
参考
以下选项可用:
选项 | 描述 |
---|---|
-h 或 --help | 显示所有可用选项 |
-v 或 --version | 输出版本号 |
--no-* | 取消默认选项。例如 --no-eslint |
--ts 或 --typescript | 初始化为 TypeScript 项目(默认) |
--js 或 --javascript | 初始化为 JavaScript 项目 |
--tailwind | 初始化包含 Tailwind CSS 配置(默认) |
--eslint | 初始化包含 ESLint 配置 |
--app | 初始化为应用路由 (App Router) 项目 |
--src-dir | 在 src/ 目录下初始化 |
--turbo | 默认启用 Turbopack 进行开发 |
--import-alias <配置的别名> | 指定使用的导入别名(默认为 "@/*") |
--empty | 初始化一个空项目 |
--use-npm | 明确告知 CLI 使用 npm 初始化应用 |
--use-pnpm | 明确告知 CLI 使用 pnpm 初始化应用 |
--use-yarn | 明确告知 CLI 使用 Yarn 初始化应用 |
--use-bun | 明确告知 CLI 使用 Bun 初始化应用 |
-e 或 --example [名称] [github-url] | 用于初始化应用的示例 |
--example-path <示例路径> | 单独指定示例路径 |
--reset-preferences | 明确告知 CLI 重置所有存储的偏好设置 |
--skip-install | 明确告知 CLI 跳过安装包 |
--yes | 对所有选项使用之前的偏好设置或默认值 |
示例
使用默认模板
要使用默认模板创建新应用,请在终端运行以下命令:
然后您将被询问以下问题:
回答完问题后,将根据您选择的配置创建一个新项目。
使用官方 Next.js 示例
要使用官方 Next.js 示例创建新应用,使用 --example
标志运行以下命令:
您可以在 Next.js 仓库 查看所有可用示例列表及设置说明。
使用任意公共 Github 示例
要使用任意公共 Github 示例创建新应用,使用 --example
选项并指定 Github 仓库 URL。例如: