Nuxt DevTools
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]
Unleash Nuxt Developer Experience.
Nuxt DevTools is a set of visual tools that help you to know your app better.
π Introduction |
π‘ Ideas & Suggestions |
πΊοΈ Project Roadmap |
π Documentation
> [!NOTE]
> You are at the `main` branch for v4. The v3 branch is [`v3`](https://github.com/nuxt/devtools/tree/v3).
## Installation
> Nuxt DevTools v4 requires **Nuxt v4.5.0 or higher** (Vite 8). It is built on [Vite DevTools](https://github.com/vitejs/devtools) and shows up as the `Nuxt` group inside the Vite DevTools panel.
Nuxt DevTools is **enabled by default**. You can press Shift + Alt / β§ Shift + β₯ Option + D in your app to open it up.
If you want to explicitly enable or disable Nuxt DevTools, you can update your `nuxt.config` with:
```js
export default defineNuxtConfig({
devtools: {
enabled: true // or false to disable
}
})
```
### Nuxt 4
Nuxt 5 ships `@nuxt/devtools-onboard`, which offers to install Nuxt DevTools v4 the first time you run `nuxt dev`; you can also install `@nuxt/devtools` with your package manager. Nuxt 4.5+ still bundles v3; override `@nuxt/devtools` to `^4.0.0` with your package manager (`overrides` in `package.json` for npm, in `pnpm-workspace.yaml` for pnpm, `resolutions` for yarn), remove your lockfile and reinstall. See the [upgrade guide](https://nuxt.com/modules/devtools/upgrading-to-v4) for details and for what changed.
### 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 using package manager resolutions:
npm
```json
{
"overrides": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```
yarn
```json
{
"resolutions": {
"@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
}
}
```
pnpm
```yaml
# pnpm-workspace.yaml
overrides:
'@nuxt/devtools': 'npm:@nuxt/devtools-nightly@latest'
```
Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.
### Module Options
To configure Nuxt DevTools, you can pass the `devtools` options.
```ts
// nuxt.config.ts
export default defineNuxtConfig({
devtools: {
// Enable devtools (default: true)
enabled: true,
// Coder code-server options (enabled by default)
codeServer: {},
// ...other options
}
})
```
For all options available, please refer to TSDocs in your IDE, or the [type definition file](https://github.com/nuxt/devtools/blob/main/packages/devtools-kit/src/_types/options.ts).
## Features
Read the [**Announcement Blog Post π**](https://nuxt.com/blog/nuxt-devtools-v1-0) for why we built Nuxt DevTools and what it can do!
## Module Authors
Please refer to the [Module Authors Guide](https://nuxt.com/modules/devtools/module-authors).
## Contribution Guide
Please refer to the [Contribution Guide](https://nuxt.com/modules/devtools/contributing).
## Anonymous Usage Analytics
Nuxt DevTools collects anonymous telemetry data about general usage. This helps us to accurately gauge feature usage and customization across all our users. This data will let us better understand how each features in Nuxt DevTools are used, measuring improvements made (DX and performances) and their relevance. It would also help us to prioritize our efforts and focus on the features that matter the most to our users.
Nuxt DevTools' telemetry data is piped through [Nuxt Telemetry](https://github.com/nuxt/telemetry), meaning that Nuxt DevTools will respect your local and global Nuxt Telemetry settings. You can also opt-out Nuxt DevTools' telemetry in the Nuxt DevTools settings.
Nuxt DevTools also respects the [`DO_NOT_TRACK`](https://donottrack.sh/) environment variable convention β set `DO_NOT_TRACK=1` in your environment to disable Nuxt DevTools telemetry regardless of any other setting.
The data we collect is completely anonymous, not traceable to the source (using hash+seed), and only meaningful in aggregate form. No data we collect is personally identifiable or trackable.
### Events
On top of the [default Nuxt Telemetry events](https://github.com/nuxt/telemetry#events), Nuxt DevTools also collects the following events:
- Versions of Nuxt DevTools
- Navigations between tabs/feature
- This helps us to understand which features are used the most to prioritize our efforts.
- Browser and OS names and versions
- This helps us improve compatibility across different browsers and operating systems.
- Click event on some action buttons
## License
[MIT](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/devtools/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/devtools
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npm.chart.dev/@nuxt/devtools
[license-src]: https://img.shields.io/npm/l/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxt/devtools
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com
[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/devtools?utm_source=nuxt_devtools_readme