Spring Boot Dashboard for VS Code

Spring Boot Dashboard is a lightweight extension in Visual Studio Code (VS Code). With an explorer in the side bar, you can view and manage all available Spring Boot projects in your workspace. It also supports the features to quickly start, stop or debug a Spring Boot project. For more advanced Spring support in VS Code, please check the Spring Boot Extension Pack.

Feature List

• View Spring Boot apps in workspace
• Start / Stop a Spring Boot app
• Debug a Spring Boot app
• Open a Spring Boot app in browser
• List beans/endpoint mappings
• View bean dependencies

Prerequisites

• JDK (version 1.8.0 or later)
• VS Code (version 1.19.0 or later)

How to install

Open VS Code and press F1 or Ctrl + Shift + P to open command palette, select Install Extension and type vscode-spring-boot-dashboard.

Or launch VS Code Quick Open (Ctrl + P), paste the following command, and press enter.

ext install vscode-spring-boot-dashboard

Note: this extension has a dependency on VS Code extensions of Debugger for Java and Spring Boot Tools.

How to get started

• Launch VS Code
• Expand the Spring Boot Dashboard explorer in the side bar
• View all available Spring Boot apps in current workspace
• Right click on a certain app and choose to start, stop or debug it
• Right click on a certain app and open the website in a browser

Custom Java launch configurations

The dashboard also offers concrete Java main classes from the app's workspace-folder launch.json, including main classes supplied by libraries. Set projectName to the app's project name when a folder contains multiple Spring Boot apps; configurations without projectName are used only when the folder contains one app.

Configurations in a .code-workspace file require projectName when the workspace contains multiple apps, even if each folder contains only one app. If another app's workspace ownership cannot be resolved, unscoped configurations are excluded, but configurations with the current app's projectName remain available.

Discovered main classes in test source folders are excluded. If neither non-test main classes nor eligible custom launchers are available, the dashboard falls back to the test-only list. A test main explicitly named in an eligible custom launch configuration remains available.

For linked or unmanaged projects whose Eclipse metadata lives outside the opened folder, the dashboard locates the workspace through the app's own sources. Run and Debug use that folder's launch configuration and working directory without rewriting the configuration's custom arguments, environment, or classpath.

Data/Telemetry

VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

Contributing

For local setup, debugging and development commands, see CONTRIBUTING.md.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.