-
Notifications
You must be signed in to change notification settings - Fork 0
Build Profiles
Build profiles control which runtime debug backend is compiled into the process and which transport the plugin uses to connect to it. Selecting the right profile is essential for using the Runtime Inspector.
| Profile | Runtime Mode | Description |
|---|---|---|
| Auto (default) | auto | Uses the runtime backend if it is available in the installed SDK. Currently falls back to none in most configurations — switch to a Dev profile if you need the inspector. |
| Dev (gRPC) | grpc | Enables the gRPC runtime backend on port 50060. Works on macOS and Linux. Requires grpcurl. |
| Dev (DBus) | dbus | Enables the DBus runtime backend on the session bus. Linux only. |
| Release | none | Runtime backend disabled. No inspector. Use for CI builds and production deployments. |
Click the build profile item in the VS Code status bar (bottom left, shows the current profile name). A quick-pick list appears — select the desired profile.
The status bar item updates immediately. The new profile takes effect on the next build.
Selecting a profile changes three things:
-
Build flag — the
--runtime-modeflag passed toscripts/build.shwhen the Build action is triggered. - Inspector transport — which backend the Runtime Inspector uses to connect (gRPC or DBus).
- Inspector UI state — whether the Runtime section in the service detail panel is shown as active or disabled.
The extension passes the selected profile to the project's build script as a --runtime-mode argument:
# Dev (gRPC)
scripts/build.sh --runtime-mode grpc
# Dev (DBus)
scripts/build.sh --runtime-mode dbus
# Release
scripts/build.sh --runtime-mode noneYour build.sh is responsible for translating this argument into the corresponding CMake flag:
--runtime-mode |
CMake flag |
|---|---|
grpc |
-DSERP_BUILD_RUNTIME_GRPC=ON |
dbus |
-DSERP_BUILD_RUNTIME_DBUS=ON |
none |
(both flags off) |
| Situation | Recommended profile |
|---|---|
| Development on macOS | Dev (gRPC) |
| Development on Linux | Dev (DBus) |
| CI builds | Release |
| Production deployments | Release |
| Default / exploratory (inspector not needed) | Auto |
| Auto isn't enabling the inspector | Switch to the appropriate Dev profile |
- Runtime Inspector — Using the inspector once a Dev profile is active
- Architecture Dashboard — Building and running deployments from the dashboard
- Plugin Overview — Status bar items and keyboard shortcuts
Getting Started
The Development Model
Architecture Language
Code Generator
- Generator Overview
- Generated Code Layout
- Deployment Configurations
- Lifecycle Backends
- CMake Integration
Framework Internals
- Core Concepts
- Services & Lifecycle
- Methods
- Properties
- Notifications
- Timers & Watchdog
- Promises & Async
- Streams
- Commands
- Logging
- Test Engine
- Transports
- Runtime & Debug Tools
VS Code Plugin
Examples