CLI
create-next-app
CLI 允许你使用默认模板或从公共 GitHub 仓库中的示例创建新的 Next.js 应用。这是开始使用 Next.js 最简单的方式。
基本用法:
参考
以下是可用的选项:
选项 | 说明 |
---|---|
-h 或 --help | 显示所有可用选项 |
-v 或 --version | 输出版本号 |
--no-* | 否定默认选项。例如 --no-eslint |
--ts 或 --typescript | 初始化为 TypeScript 项目(默认) |
--js 或 --javascript | 初始化为 JavaScript 项目 |
--tailwind | 初始化 Tailwind CSS 配置(默认) |
--eslint | 初始化 ESLint 配置 |
--app | 初始化为 App 路由项目 |
--src-dir | 在 src/ 目录中初始化 |
--turbopack | 默认启用 Turbopack 进行开发 |
--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 跳过安装包 |
--yes | 对所有选项使用之前的偏好设置或默认值 |
示例
使用默认模板
要使用默认模板创建新应用,在终端中运行以下命令:
然后你会看到以下提示:
回答完这些提示后,将会使用你选择的配置创建一个新项目。
使用官方 Next.js 示例
要使用官方 Next.js 示例创建新应用,使用 --example
标志。例如:
你可以在 Next.js 仓库中查看所有可用示例的列表以及设置说明。
使用任何公共 GitHub 示例
要使用任何公共 GitHub 示例创建新应用,使用 --example
选项和 GitHub 仓库的 URL。例如: