Skip to main content

create-next-app

create-next-app CLI 允许你使用默认模板或来自公共 GitHub 存储库的 example 创建新的 Next.js 应用。这是开始使用 Next.js 的最简单方法。

¥The create-next-app CLI allow you to create a new Next.js application using the default template or an example from a public GitHub repository. It is the easiest way to get started with Next.js.

基本用法:

¥Basic usage:

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

参考

¥Reference

可以使用以下选项:

¥The following options are available:

选项描述
-h--help显示所有可用选项
-v--version输发布本号
--no-*否定默认选项。例如。--no-eslint
--ts--typescript初始化为 TypeScript 项目(默认)
--js--javascript初始化为 JavaScript 项目
--tailwind使用 Tailwind CSS 配置初始化(默认)
--eslint使用 ESLint 配置初始化
--app初始化为 App Router 项目
--src-dirsrc/ 目录内初始化
--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对所有选项使用以前的首选项或默认值

示例

¥Examples

使用默认模板

¥With the default template

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

¥To create a new app using the default template, run the following command in your terminal:

npx create-next-app@latest

然后系统会询问你以下提示:

¥You will then be asked the following prompts:

What is your project named?  my-app
Would you like to use TypeScript? No / Yes
Would you like to use ESLint? 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 for `next dev`? No / Yes
Would you like to customize the import alias (`@/*` by default)? No / Yes

回答提示后,将使用你选择的配置创建一个新项目。

¥Once you've answered the prompts, a new project will be created with your chosen configuration.

使用官方 Next.js 示例

¥With an official Next.js example

要使用官方 Next.js 示例创建新应用,请使用 --example 标志。例如:

¥To create a new app using an official Next.js example, use the --example flag. For example:

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

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

¥You can view a list of all available examples along with setup instructions in the Next.js repository.

使用任何公开 GitHub 示例

¥With any public GitHub example

要使用任何公共 GitHub 示例创建新应用,请将 --example 选项与 GitHub 存储库的 URL 一起使用。例如:

¥To create a new app using any public GitHub example, use the --example option with the GitHub repo's URL. For example:

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