Skip to content

docs: add package resolution instructions for v4.0 opt-in #956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antfu merged 1 commit into from
Mar 18, 2026
+146 −10
Merged

docs: add package resolution instructions for v4.0 opt-in #956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 84 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,100 @@ export default defineNuxtConfig({
})
```

### Opting in to v4.0

Nuxt DevTools v4.0 is currently in alpha. Since Nuxt ships with a built-in version of DevTools, you can opt-in to v4.0 by using package manager resolutions to override the bundled version:

<details>
<summary>npm</summary>

```json
{
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

</details>

<details>
<summary>yarn</summary>

```json
{
"resolutions": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

</details>

<details>
<summary>pnpm</summary>

```json
{
"pnpm": {
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
}
```

</details>

Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

### Nightly Release Channel

Similar to [Nuxt's Nightly Channel](https://nuxt.com/docs/guide/going-further/nightly-release-channel), DevTools also offers a nightly release channel, that automatically releases for every commit to `main` branch.

You can opt-in to the nightly release channel by running:
You can opt-in to the nightly release channel by using package manager resolutions:

<details>
<summary>npm</summary>

```json
{
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

</details>

<details>
<summary>yarn</summary>

```json
{
"resolutions": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

</details>

```diff
<details>
<summary>pnpm</summary>

```json
{
"devDependencies": {
-- "@nuxt/devtools": "^0.1.0"
++ "@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
"pnpm": {
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
}
```

</details>

Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

### Module Options
Expand Down
67 changes: 62 additions & 5 deletions docs/content/1.guide/0.getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,78 @@ export default defineNuxtConfig({

Restart your Nuxt server and open your app in browser. Click the Nuxt icon on the bottom (or press :kbd{value="Shift"} + :kbd{value="Alt"} / :kbd{value="⇧ Shift"} + :kbd{value="⌥ Option"} + :kbd{value="D"}) to toggle the DevTools.

### Opting in to v4.0

Nuxt DevTools v4.0 is currently in alpha. Since Nuxt ships with a built-in version of DevTools, you can opt-in to v4.0 by using package manager resolutions to override the bundled version:

::code-group

```json [npm]
{
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

```json [yarn]
{
"resolutions": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

```json [pnpm]
{
"pnpm": {
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
}
```

::

Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

### Nightly Release Channel

Similar to [Nuxt's Nightly Channel](https://nuxt.com/docs/guide/going-further/nightly-release-channel), DevTools also offers a nightly release channel, that automatically releases for every commit to `main` branch.

You can opt-in to the nightly release channel by running:
You can opt-in to the nightly release channel by using package manager resolutions:

::code-group

```json [npm]
{
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

```json [yarn]
{
"resolutions": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```

```diff
```json [pnpm]
{
"devDependencies": {
-- "@nuxt/devtools": "^0.1.0"
++ "@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
"pnpm": {
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
}
```

::

Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

### Module Options
Expand Down
Loading