diff --git a/packages/create-next-app/README.md b/packages/create-next-app/README.md index 1c37e54484f9..35501a29373f 100644 --- a/packages/create-next-app/README.md +++ b/packages/create-next-app/README.md @@ -2,6 +2,10 @@ The easiest way to get started with Next.js is by using `create-next-app`. This CLI tool enables you to quickly start building a new Next.js application, with everything set up for you. You can create a new app using the default Next.js template, or by using one of the [official Next.js examples](https://github.com/vercel/next.js/tree/canary/examples). To get started, use the following command: +### Interactive + +You can create a new project interactively by running: + ```bash npx create-next-app@latest # or @@ -10,41 +14,60 @@ yarn create next-app pnpm create next-app ``` -Or, for a [TypeScript project](https://github.com/vercel/next.js/blob/canary/docs/basic-features/typescript.md): +You will be asked for the name of your project, and then whether you want to +create a TypeScript project: ```bash -npx create-next-app@latest --typescript -# or -yarn create next-app --typescript -# or -pnpm create next-app --typescript +✔ Would you like to use TypeScript with this project? … No / Yes ``` -To create a new app in a specific folder, you can send a name as an argument. For example, the following command will create a new Next.js app called `blog-app` in a folder with the same name: +Select **Yes** to install the necessary types/dependencies and create a new TS project. + +### Non-interactive + +You can also pass command line arguments to set up a new project +non-interactively. See `create-next-app --help`: ```bash -npx create-next-app@latest blog-app -# or -yarn create next-app blog-app -# or -pnpm create next-app blog-app -``` +create-next-app [options] + +Options: + -V, --version output the version number + --ts, --typescript -## Options + Initialize as a TypeScript project. (default) -`create-next-app` comes with the following options: + --js, --javascript -- **--ts, --typescript** - Initialize as a TypeScript project. -- **-e, --example [name]|[github-url]** - An example to bootstrap the app with. You can use an example name from the [Next.js repo](https://github.com/vercel/next.js/tree/canary/examples) or a GitHub URL. The URL can use any branch and/or subdirectory. -- **--example-path <path-to-example>** - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: `--example-path foo/bar` -- **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run `yarn create next-app` -- **--use-pnpm** - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using pnpm we recommend running `pnpm create next-app` + Initialize as a JavaScript project. + + --use-npm + + Explicitly tell the CLI to bootstrap the app using npm + + --use-pnpm + + Explicitly tell the CLI to bootstrap the app using pnpm + + -e, --example [name]|[github-url] + + An example to bootstrap the app with. You can use an example name + from the official Next.js repo or a GitHub URL. The URL can use + any branch and/or subdirectory + + --example-path + + In a rare case, your GitHub URL might contain a branch name with + a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). + In this case, you must specify the path to the example separately: + --example-path foo/bar +``` -## Why use Create Next App? +### Why use Create Next App? `create-next-app` allows you to create a new Next.js app within seconds. It is officially maintained by the creators of Next.js, and includes a number of benefits: -- **Interactive Experience**: Running `npx create-next-app` (with no arguments) launches an interactive experience that guides you through setting up a project. +- **Interactive Experience**: Running `npx create-next-app@latest` (with no arguments) launches an interactive experience that guides you through setting up a project. - **Zero Dependencies**: Initializing a project is as quick as one second. Create Next App has zero dependencies. - **Offline Support**: Create Next App will automatically detect if you're offline and bootstrap your project using your local package cache. - **Support for Examples**: Create Next App can bootstrap your application using an example from the Next.js examples collection (e.g. `npx create-next-app --example api-routes`).