mirror of
https://github.com/oven-sh/bun
synced 2026-02-02 15:08:46 +00:00
48 lines
2.2 KiB
Plaintext
48 lines
2.2 KiB
Plaintext
---
|
|
title: Debugging Bun with the VS Code extension
|
|
sidebarTitle: VS Code debugger
|
|
mode: center
|
|
---
|
|
|
|
<Note>
|
|
VSCode extension support is currently buggy. We recommend the [Web Debugger](/guides/runtime/web-debugger) for now.
|
|
</Note>
|
|
|
|
Bun speaks the [WebKit Inspector Protocol](https://github.com/oven-sh/bun/blob/main/packages/bun-inspector-protocol/src/protocol/jsc/index.d.ts) so you can debug your code with an interactive debugger.
|
|
|
|
---
|
|
|
|
To install the extension, visit the [Bun for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=oven.bun-vscode) page on the VS Code marketplace website, then click Install.
|
|
|
|
<Frame></Frame>
|
|
|
|
---
|
|
|
|
Alternatively, search `bun-vscode` in the Extensions tab of VS Code.
|
|
|
|
<Frame></Frame>
|
|
|
|
---
|
|
|
|
Make sure you are installing the extension published by the verified Oven organization.
|
|
|
|
<Frame></Frame>
|
|
|
|
---
|
|
|
|
Once installed, two new Bun-specific commands will appear in the Command Palette. To open the palette, click View > Command Palette, or type `Ctrl+Shift+P` (Windows, Linux) or `Cmd+Shift+P` on (Mac).
|
|
|
|
---
|
|
|
|
The `Bun: Run File` command will execute your code and print the output to the Debug Console in VS Code. Breakpoints will be ignored; this is similar to executing the file with `bun <file>` from the command line.
|
|
|
|
<Frame></Frame>
|
|
|
|
---
|
|
|
|
The `Bun: Debug File` command will execute your code and print the output to the Debug Console in VS Code. You can set breakpoints in your code by clicking to the left of a line number; a red dot should appear.
|
|
|
|
When you run the file with `Bun: Debug File`, execution will pause at the breakpoint. You can inspect the variables in scope and step through the code line-by-line using the VS Code controls.
|
|
|
|
<Frame></Frame>
|