跳到主要內容
API 參考CLIcreate-next-app

create-next-app

create-next-app CLI 允許您使用預設範本或來自公開 GitHub 儲存庫的範例,來建立新的 Next.js 應用程式。這是開始使用 Next.js 最簡單的方式。

基本用法

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

參考

以下選項可用

選項描述
-h--help顯示所有可用選項
-v--version輸出版本號碼
--no-*否定預設選項。例如 --no-eslint
--ts--typescript初始化為 TypeScript 專案(預設)
--js--javascript初始化為 JavaScript 專案
--tailwind使用 Tailwind CSS 設定初始化(預設)
--eslint使用 ESLint 設定初始化
--app初始化為 App Router 專案
--api初始化一個僅包含路由處理器的專案
--src-dirsrc/ 目錄內初始化
--turbopack預設啟用 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對所有選項使用先前的偏好設定或預設值

範例

使用預設範本

若要使用預設範本建立新的應用程式,請在終端機中執行以下命令

終端機
npx create-next-app@latest

然後您會被詢問以下提示

終端機
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

一旦您回答完提示,就會使用您選擇的設定建立一個新的專案。

使用官方 Next.js 範例

若要使用官方 Next.js 範例建立新的應用程式,請使用 --example 標記。例如

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

您可以在 Next.js 儲存庫中查看所有可用範例的列表以及設定說明。

使用任何公開的 GitHub 範例

若要使用任何公開的 GitHub 範例建立新的應用程式,請使用 --example 選項並帶上 GitHub 儲存庫的 URL。例如

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