Nuxt/docs/content/1.getting-started/3.commands.md

74 lines
1.5 KiB
Markdown
Raw Normal View History

# Commands
Nuxi is the new CLI experience for Nuxt 3
2021-11-21 12:31:44 +00:00
Nuxt 3 has two main commands, one to start the development server and one to make production assets.
Since Nuxt 3 becomes a dev dependency thanks to the new [Nitro server](/concepts/server-engine), you only need to add two commands in your `package.json`:
```json [package.json]
"scripts": {
"dev": "nuxi dev",
"build": "nuxi build",
}
```
Then, you can run each command using `npm run <command>` or `yarn <command>`.
## Development Server
To start Nuxt in development mode with hot module replacement on <http://localhost:3000>:
::code-group
```bash [Yarn]
yarn dev
```
```bash [NPM]
npm run dev
```
::
To start Nuxt in development mode with HTTPS <https://localhost:3000> (self-signed certificate):
::code-group
```bash [Yarn]
yarn dev --https
```
```bash [NPM]
npm run dev -- --https
```
::
::alert
`options.server` from `nuxt.config` is not supported. You can use `--port`, `--host`, `--https`, `--ssl-cert` and `--ssl-key` instead.
::
## Building for production
To build your Nuxt application for production, run:
::code-group
```bash [Yarn]
yarn build
```
```bash [NPM]
npm run build
```
::
2021-11-21 12:31:44 +00:00
Nuxt will create a [`.output`](/docs/directory-structure/output) directory with all your application, server and dependencies ready to be deployed. Check out the [deployment](/docs/deployment) section to learn where and how you can deploy a Nuxt application using Nitro.
## CLI glossary
::alert{type="success"}
Nuxi has more commands listed in a complete [CLI glossary](/docs/usage/cli)
::