Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2025-01-18 17:35:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(commands): add tunnel option

Browse Source
This commit is contained in:
Sébastien Chopin 2023-12-06 16:18:34 +01:00 committed by GitHub
parent 64146b4a5d
commit 50d46f068a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/3.api/4.commands/dev.md
View File

@ -9,7 +9,7 @@ links:
--- ---
```bash [Terminal] ```bash [Terminal]
npx nuxi dev [rootDir] [--dotenv] [--log-level] [--clipboard] [--open, -o] [--no-clear] [--port, -p] [--host, -h] [--https] [--ssl-cert] [--ssl-key] npx nuxi dev [rootDir] [--dotenv] [--log-level] [--clipboard] [--open, -o] [--no-clear] [--port, -p] [--host, -h] [--https] [--ssl-cert] [--ssl-key] [--tunnel]
``` ```
The `dev` command starts a development server with hot module replacement at [http://localhost:3000](https://localhost:3000) The `dev` command starts a development server with hot module replacement at [http://localhost:3000](https://localhost:3000)
@ -18,14 +18,15 @@ Option | Default | Description
-------------------------|-----------------|------------------ -------------------------|-----------------|------------------
`rootDir` | `.` | The root directory of the application to serve. `rootDir` | `.` | The root directory of the application to serve.
`--dotenv` | `.` | Point to another `.env` file to load, **relative** to the root directory. `--dotenv` | `.` | Point to another `.env` file to load, **relative** to the root directory.
`--clipboard` | `false` | Copy URL to clipboard.
`--open, -o` | `false` | Open URL in browser. `--open, -o` | `false` | Open URL in browser.
`--clipboard` | `false` | Copy URL to clipboard.
`--no-clear` | `false` | Does not clear the console after startup. `--no-clear` | `false` | Does not clear the console after startup.
`--port, -p` | `3000` | Port to listen. `--port, -p` | `3000` | Port to listen.
`--host, -h` | `localhost` | Hostname of the server. `--host, -h` | `localhost` | Hostname of the server.
`--https` | `false` | Listen with `https` protocol with a self-signed certificate by default. `--https` | `false` | Listen with `https` protocol with a self-signed certificate by default.
`--ssl-cert` |`null` | Specify a certificate for https. `--ssl-cert` |`null` | Specify a certificate for https.
`--ssl-key` |`null` | Specify the key for the https certificate. `--ssl-key` |`null` | Specify the key for the https certificate.
`--tunnel` | `false` | Tunnel your local server to the internet with [unjs/untun](https://github.com/unjs/untun)
The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables. The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables.