Skip to content

nuxt/create-nuxt-app

Repository files navigation

Create Nuxt App

NPM version NPM downloads GitHub Action

Create a Nuxt.js project in seconds

Usage

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

npx create-nuxt-app <my-project>

Or starting with npm v6.1 you can do:

npm init nuxt-app@latest <my-project>

Or with yarn:

yarn create nuxt-app <my-project>

Features 🎉

  1. Package manager
    • Yarn
    • Npm
  2. Programming language
    • JavaScript
    • TypeScript
  3. UI framework:
  4. Template engine
    • HTML
    • Pug
  5. Nuxt.js modules:
  6. Linting tools:
  7. Testing framework:
  8. Rendering mode
  9. Deployment target
  10. Development tools
  11. Continuous Integration

CLI Options

--edge

Alias: -e.

To install nuxt-edge instead of nuxt, add the command line option --edge:

npx create-nuxt-app <my-project> --edge

Or

npm init nuxt-app <my-project> --edge

Or

yarn create nuxt-app <my-project> --edge

--info

Alias: -i. Print out debugging information relating to the local environment and exit.

--help

Alias: -h. Show the help information and exit, include: usage, command and all cli options.

--verbose

Show debug logs

--version

Alias: -v. Show version number and exit.

--overwrite-dir

Overwrite the target directory.

Credits