Skip to content


    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. To get started, use the following command:


    You can create a new project interactively by running:

    npx create-next-app@latest
    yarn create next-app
    pnpm create next-app

    You will then be asked the following prompts:

    What is your project named?  my-app
    Would you like to add TypeScript with this project?  Y/N
    Would you like to use ESLint with this project?  Y/N
    Would you like to use Tailwind CSS with this project? Y/N
    Would you like to use the `src/ directory` with this project? Y/N
    What import alias would you like configured? `@/*`

    Once you've answered the prompts, a new project will be created with the correct configuration depending on your answers.


    You can also pass command line arguments to set up a new project non-interactively.

    Further, you can negate default options by prefixing them with --no- (e.g. --no-eslint).

    See create-next-app --help:

    Usage: create-next-app <project-directory> [options]
      -V, --version                        output the version number
      --ts, --typescript
        Initialize as a TypeScript project. (default)
      --js, --javascript
        Initialize as a JavaScript project.
        Initialize with Tailwind CSS config. (default)
        Initialize with ESLint config.
        Initialize inside a `src/` directory.
      --import-alias <alias-to-configure>
        Specify import alias to use (default "@/*").
        Explicitly tell the CLI to bootstrap the app using npm
        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 <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
        Explicitly tell the CLI to reset any stored preferences
      -h, --help                           output usage information

    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@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).
    • Tested: The package is part of the Next.js monorepo and tested using the same integration test suite as Next.js itself, ensuring it works as expected with every release.

    Was this helpful?