{"id":13595202,"url":"https://github.com/nuxt/devtools","last_synced_at":"2025-05-14T08:05:16.998Z","repository":{"id":65780848,"uuid":"420050565","full_name":"nuxt/devtools","owner":"nuxt","description":"Unleash Nuxt Developer Experience","archived":false,"fork":false,"pushed_at":"2025-05-06T10:55:59.000Z","size":14925,"stargazers_count":3086,"open_issues_count":84,"forks_count":178,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-05-07T07:18:17.888Z","etag":null,"topics":["dx","nuxt","nuxt-devtools","nuxt-module"],"latest_commit_sha":null,"homepage":"https://devtools.nuxt.com","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nuxt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-10-22T10:05:53.000Z","updated_at":"2025-05-07T03:11:14.000Z","dependencies_parsed_at":"2023-11-06T14:28:30.570Z","dependency_job_id":"8e370681-dbd1-4753-89b8-49f547f7aa9b","html_url":"https://github.com/nuxt/devtools","commit_stats":{"total_commits":1240,"total_committers":83,"mean_commits":"14.939759036144578","dds":0.3895161290322581,"last_synced_commit":"b38cafba57410379fbdc9cea4a0c57a7aa20c35d"},"previous_names":[],"tags_count":144,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt%2Fdevtools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt%2Fdevtools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt%2Fdevtools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt%2Fdevtools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuxt","download_url":"https://codeload.github.com/nuxt/devtools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253133114,"owners_count":21859112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dx","nuxt","nuxt-devtools","nuxt-module"],"created_at":"2024-08-01T16:01:45.634Z","updated_at":"2025-05-14T08:05:16.979Z","avatar_url":"https://github.com/nuxt.png","language":"Vue","funding_links":[],"categories":["Vue","nuxt"],"sub_categories":[],"readme":"\u003ca href=\"https://devtools.nuxt.com\"\u003e\u003cimg width=\"1200\" alt=\"Nuxt DevTools\" src=\"https://github-production-user-asset-6210df.s3.amazonaws.com/904724/261577617-a10567bd-ad33-48cc-9bda-9e37dbe1929f.png\"\u003e\u003c/a\u003e\n\u003cbr\u003e\n\n\u003ch1\u003e\nNuxt DevTools\n\u003c/h1\u003e\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n[![Volta][volta-src]][volta-href]\n\n\u003cp\u003e\nUnleash Nuxt Developer Experience.\n\u003cbr\u003eNuxt DevTools is a set of visual tools that help you to know your app better.\n\u003c/p\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://nuxt.com/blog/nuxt-devtools-v1-0\"\u003e👋 Introduction\u003c/a\u003e |\n  \u003ca href=\"https://github.com/nuxt/devtools/discussions/29\"\u003e💡 Ideas \u0026 Suggestions\u003c/a\u003e |\n  \u003ca href=\"https://github.com/nuxt/devtools/discussions/31\"\u003e🗺️ Project Roadmap\u003c/a\u003e |\n  \u003ca href=\"https://devtools.nuxt.com/\"\u003e📚 Documentation\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n## Installation\n\n\u003e Nuxt DevTools v2 requires **Nuxt v3.15.0 or higher**.\n\nNuxt DevTools is **enabled by default** in Nuxt v3.8.0. You can press \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eAlt\u003c/kbd\u003e / \u003ckbd\u003e⇧ Shift\u003c/kbd\u003e + \u003ckbd\u003e⌥ Option\u003c/kbd\u003e + \u003ckbd\u003eD\u003c/kbd\u003e in your app to open it up.\n\nIf you want to explicitly enable or disable Nuxt DevTools, you can update your `nuxt.config` with:\n\n```js\nexport default defineNuxtConfig({\n  devtools: {\n    enabled: true // or false to disable\n  }\n})\n```\n\n### Nightly Release Channel\n\nSimilar 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.\n\nYou can opt-in to the nightly release channel by running:\n\n```diff\n{\n  \"devDependencies\": {\n--    \"@nuxt/devtools\": \"^0.1.0\"\n++    \"@nuxt/devtools\": \"npm:@nuxt/devtools-nightly@latest\"\n  }\n}\n```\n\nRemove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.\n\n### Module Options\n\nTo configure Nuxt DevTools, you can pass the `devtools` options.\n\n```ts\n// nuxt.config.ts\nexport default defineNuxtConfig({\n  devtools: {\n    // Enable devtools (default: true)\n    enabled: true,\n    // VS Code Server options\n    vscode: {},\n    // ...other options\n  }\n})\n```\n\nFor 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).\n\n## Features\n\nRead the [**Announcement Blog Post 🎊**](https://nuxt.com/blog/nuxt-devtools-v1-0) for why we built Nuxt DevTools and what it can do!\n\n## Module Authors\n\nPlease refer to the [Module Authors Guide](https://devtools.nuxt.com/module/guide).\n\n## Contribution Guide\n\nPlease refer to the [Contribution Guide](https://devtools.nuxt.com/development/contributing).\n\n## Anonymous Usage Analytics\n\nNuxt 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.\n\nNuxt 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.\n\nThe 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.\n\n### Events\n\nOn top of the [default Nuxt Telemetry events](https://github.com/nuxt/telemetry#events), Nuxt DevTools also collects the following events:\n\n- Versions of Nuxt DevTools\n- Navigations between tabs/feature\n  - This helps us to understand which features are used the most to prioritize our efforts.\n- Browser and OS names and versions\n  - This helps us improve compatibility across different browsers and operating systems.\n- Click event on some action buttons\n\n## License\n\n[MIT](./LICENSE)\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/@nuxt/devtools/latest.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/@nuxt/devtools\n[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/devtools.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-downloads-href]: https://npm.chart.dev/@nuxt/devtools\n[license-src]: https://img.shields.io/npm/l/@nuxt/devtools.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[license-href]: https://npmjs.com/package/@nuxt/devtools\n[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg\n[volta-href]: https://volta.net/nuxt/devtools?utm_source=nuxt_devtools_readme\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt%2Fdevtools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuxt%2Fdevtools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt%2Fdevtools/lists"}