You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: 'Visualize and analyze your Vite build process with powerful developer tools. Extensible architecture for building custom DevTools integrations.',
35
+
description: 'An extensible devtools framework for the Vite ecosystem. Build, compose, and integrate developer tools with a unified foundation.',
Copy file name to clipboardExpand all lines: docs/.vitepress/theme/Home.vue
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,16 @@ import Spacer from '@components/shared/Spacer.vue'
11
11
12
12
<HeadingSection
13
13
heading="Inspect, Analyze, Extend"
14
-
subheading="Vite DevTools not only provides built-in features, but also a extensible architecture for custom integrations."
14
+
subheading="Vite DevTools provides an extensible framework with built-in integrations like DevTools for Rolldown, plus an open architecture for custom tools."
Copy file name to clipboardExpand all lines: docs/guide/index.md
+33-19Lines changed: 33 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,33 @@ outline: deep
4
4
5
5
# Getting Started
6
6
7
-
> [!WARNING]
8
-
> Vite DevTools currently only supports build mode of Vite 8+.
9
-
> Dev mode and Vite versions under 8 are not supported yet.
10
-
11
7
## What is Vite DevTools?
12
8
13
-
Vite DevTools is a comprehensive set of developer tools for visualizing and analyzing your Vite build process. It provides deep insights into your build pipeline, module dependencies, and build metadata, helping you understand and optimize your Vite applications.
9
+
Vite DevTools is a devtools framework for the Vite ecosystem. Instead of each tool building its own devtools from scratch, Vite DevTools provides shared infrastructure — a unified dock system, type-safe RPC, shared state management, and flexible UI hosting — so that different tools compose together seamlessly, users get a consistent experience, and tool authors can focus on what makes their integration unique.
10
+
11
+
Any Vite plugin can hook into Vite DevTools with just a few lines of code, instantly gaining access to the full platform: panels, action buttons, server-client communication, and more.
12
+
13
+
### Built-in Integrations
14
+
15
+
-**[DevTools for Rolldown](/rolldown/)** — Build analysis, module graphs, chunks, assets, plugins, and performance insights
16
+
-**DevTools for Vite** — Vite-specific developer tools *(in development)*
17
+
18
+
### Ecosystem
19
+
20
+
Vite DevTools Kit is already powering a growing ecosystem of integrations:
21
+
22
+
-**[Nuxt DevTools v4](https://github.com/nuxt/devtools)** — Built on top of Vite DevTools Kit
23
+
-**[Oxc Inspector](https://github.com/yuyinws/oxc-inspector)** — Integrates via DevTools Kit with custom RPC functions
24
+
-**[UnoCSS Inspector](https://github.com/unocss/unocss)** — Dock integration for UnoCSS
25
+
-**[vite-plugin-vue-tracer](https://github.com/antfu/vite-plugin-vue-tracer)** — Action button that triggers a DOM inspector
14
26
15
27
### Key Features
16
28
17
-
-**🔍 Build Analysis**: Visualize module graphs, dependencies, and build metadata
18
-
-**📊 Performance Insights**: Understand build performance and bottlenecks
19
-
-**🧩 Extensible**: Build custom DevTools integrations with the DevTools Kit
29
+
-**🧩 Extensible Framework**: Any Vite plugin can extend the devtools with a simple hook
30
+
-**🔍 [DevTools for Rolldown](/rolldown/)**: Built-in build analysis with module graphs, dependencies, and build metadata
20
31
-**🎨 Unified Interface**: All DevTools integrations appear in a consistent dock interface
21
-
-**⚡ Type-Safe**: Full TypeScript support with type-safe RPC communication
32
+
-**🔌 Type-Safe RPC**: Built-in bidirectional communication between server and client
33
+
-**⚡ Shared State**: Automatic synchronization of data between server and client
22
34
23
35
## Installation
24
36
@@ -129,26 +141,28 @@ When `build.withApp` is enabled, running `pnpm build` will automatically generat
129
141
130
142
Now that you have Vite DevTools set up, you can:
131
143
132
-
-**Explore the built-in tools**: Check out the various panels and visualizations available in the DevTools interface
133
-
-**Build custom integrations**: Learn how to extend Vite DevTools with your own tools using the [DevTools Kit](/kit/)
144
+
-**Explore the built-in tools**: Check out the [DevTools for Rolldown](/rolldown/)panels and visualizations
145
+
-**Build custom integrations**: Learn how to extend the devtools with your own tools using the [Vite DevTools Kit](/kit/)
134
146
-**Contribute**: Help improve Vite DevTools by checking out our [contributing guide](https://github.com/antfu/contribute)
135
147
136
148
## Current Limitations
137
149
138
150
> [!NOTE]
139
-
> Vite DevTools is currently in active development with the following limitations:
151
+
> Vite DevTools is currently in active development.
140
152
141
-
-**Build mode only**: Currently works with Vite-Rolldown's build mode
142
-
-**Dev mode**: Not yet supported (planned for future releases)
143
-
-**Vite Version**: Requires Vite 8 or higher versions for now
153
+
-**[DevTools for Rolldown](/rolldown/)**: Currently supports build mode only, requires Vite 8+
154
+
-**Dev mode**: Dev mode support is planned for future releases
144
155
145
156
## Architecture Overview
146
157
147
158
Vite DevTools consists of several core packages:
148
159
149
-
-**`@vitejs/devtools`**: The main entry point and CLI
150
-
-**`@vitejs/devtools-kit`**: Utilities and types for building custom integrations
151
-
-**`@vitejs/devtools-rolldown`**: Built-in UI panel for Rolldown
160
+
-**`@vitejs/devtools`**: The core framework, CLI, and runtime hosts
161
+
-**`@vitejs/devtools-kit`**: Vite DevTools Kit — utilities and types for building custom integrations
162
+
-**`@vitejs/devtools-rolldown`**: [DevTools for Rolldown](/rolldown/) — built-in build analysis UI
163
+
-**`@vitejs/devtools-vite`**: DevTools for Vite *(in development)*
152
164
-**`@vitejs/devtools-rpc`**: RPC layer for server-client communication
153
165
154
-
For more details on extending Vite DevTools, see the [DevTools Kit documentation](/kit/).
166
+
Third-party integrations like [Oxc Inspector](https://github.com/yuyinws/oxc-inspector) can also integrate via the DevTools Kit plugin API.
167
+
168
+
For more details on extending the devtools, see the [Vite DevTools Kit documentation](/kit/).
Copy file name to clipboardExpand all lines: docs/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,8 @@ theme: dark
4
4
5
5
hero:
6
6
name: Vite DevTools
7
-
text: DevTools for Vite.
8
-
tagline: Visualize and analyze your Vite build process with powerful developer tools
7
+
text: DevTools Framework for the Vite Ecosystem.
8
+
tagline: An extensible foundation for building and composing developer tools across the Vite ecosystem
9
9
actions:
10
10
- theme: brand
11
11
text: Get Started
@@ -19,11 +19,11 @@ hero:
19
19
20
20
features:
21
21
- icon: 🔍
22
-
title: Build Analysis
23
-
details: Deep insights into your Vite-Rolldown build process. Visualize module graphs, dependencies, and build metadata to understand what's happening under the hood.
22
+
title: DevTools for Rolldown
23
+
details: Built-in integration for Rolldown build analysis. Visualize module graphs, dependencies, chunks, assets, and build metadata.
24
24
- icon: 🧩
25
25
title: Extensible Architecture
26
-
details: Build custom DevTools integrations with the DevTools Kit. Extend any Vite plugin with a simple devtools hook to add your own visualizations and tools.
26
+
details: Build custom DevTools integrations with the DevTools Kit. Any Vite plugin can extend the devtools with a simple hook to add visualizations, inspectors, and tools.
27
27
- icon: 🚀
28
28
title: Unified Dock System
29
29
details: A familiar dock interface (like macOS Dock) where all DevTools integrations appear together. Switch between tools seamlessly in a consistent UI.
The docs might not cover all the details—please help us improve them by submitting PRs. In the meantime, refer to these existing DevTools integrations:
56
+
57
+
-**[UnoCSS Inspector](https://github.com/unocss/unocss/blob/25c0dd737132dc20b257c276ee2bc3ccc05e2974/packages-integrations/inspector/src/index.ts#L140-L150)** - A simple iframe-based dock entry
58
+
-**[vite-plugin-vue-tracer](https://github.com/antfu/vite-plugin-vue-tracer)** - An action button that triggers a DOM inspector
Copy file name to clipboardExpand all lines: docs/kit/index.md
+1-11Lines changed: 1 addition & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,14 +100,4 @@ If you're building a Vite plugin and want to add DevTools capabilities, or if yo
100
100
4.**[Shared State](./shared-state)** - Share data between server and client with automatic synchronization
101
101
102
102
> [!TIP] Help Us Improve
103
-
> If you are building something on top of Vite DevTools, we invite you to label your repository with `vite-devtools` on GitHub to help us track usage and improve the project. Thank you!
104
-
105
-
## Real-World Examples
106
-
107
-
The docs might not cover all the details—please help us improve them by submitting PRs. In the meantime, refer to these existing DevTools integrations:
108
-
109
-
-**[UnoCSS Inspector](https://github.com/unocss/unocss/blob/25c0dd737132dc20b257c276ee2bc3ccc05e2974/packages-integrations/inspector/src/index.ts#L140-L150)** - A simple iframe-based dock entry
110
-
-**[vite-plugin-vue-tracer](https://github.com/antfu/vite-plugin-vue-tracer)** - An action button that triggers a DOM inspector
-**[Oxc Inspector](https://github.com/yuyinws/oxc-inspector/blob/main/src/vite.ts)** - An iframe-based dock entry with custom RPC functions
103
+
> If you are building something on top of Vite DevTools Kit, we invite you to label your repository with `vite-devtools` on GitHub to help us track usage and improve the project. Thank you!
DevTools for Rolldown (`@vitejs/devtools-rolldown`) is a built-in integration that provides comprehensive build analysis for Vite projects using Rolldown. It comes included with Vite DevTools out of the box.
8
+
9
+
> [!WARNING]
10
+
> DevTools for Rolldown currently only supports build mode of Vite 8+.
11
+
> Dev mode and Vite versions under 8 are not supported yet.
12
+
13
+
## What It Does
14
+
15
+
DevTools for Rolldown gives you deep insights into your Rolldown-powered build process:
16
+
17
+
-**Module Analysis** — Visualize module graphs, dependencies, and transformation flows
18
+
-**Plugin Insights** — Inspect plugin hook costs and processed modules
19
+
-**Chunk & Asset Analysis** — Explore build output with list, graph, treemap, and flamegraph views
20
+
-**Package Detection** — Detect duplicated packages and analyze dependency sizes
21
+
-**Session Compare** — Compare bundle changes across builds
22
+
23
+
See the [Features](/rolldown/features) page for a detailed walkthrough with screenshots.
24
+
25
+
## Getting Started
26
+
27
+
DevTools for Rolldown is automatically available when you set up Vite DevTools. Follow the [Getting Started](/guide/) guide to install and configure Vite DevTools, then the Rolldown build analysis panels will appear in the dock.
0 commit comments