Configuration keys¶
An alphabetical index of every key in .bugsaur/config.toml, for looking one up
when you know the name. The grouped version, with defaults and examples, is
Configuration → Reference.
The schema is closed: a key not on this list is a parse error that stops the launch.
| Key | Where | What it is |
|---|---|---|
adapter |
[profiles.<name>] |
adapter id from the catalog. Required |
adapter_command |
[profiles.<name>] |
overrides the adapter's command |
args |
[profiles.<name>] |
the debuggee's command-line arguments |
args |
[profiles.<name>.build] |
arguments of the build command |
bottom |
[ui.layout] |
panels below the main zone |
bottom_left |
[ui.layout] |
panels in the lower left zone |
build |
[profiles.<name>] |
how to build before launching |
command |
[profiles.<name>.build] |
the build executable. Required in the table |
cwd |
[profiles.<name>] |
working directory; defaults to the project root |
default |
top level | profile used when no name is given |
env |
[profiles.<name>] |
environment variables; strongest layer |
env_file |
[profiles.<name>] |
file of environment variables |
keymaps |
[ui] |
window hotkeys, action → chord |
launch_arguments |
[profiles.<name>] |
the DAP body, passed through as-is |
launch_timeout |
[profiles.<name>] |
seconds for launch / attach and configurationDone responses |
layout |
[ui] |
panel layout |
left |
[ui.layout] |
share of the window width for the left column |
left_split |
[ui.layout] |
share of the column height for top_left |
main |
[ui.layout] |
panels in the main zone |
main_split |
[ui.layout] |
share of the right area's height for main |
mode |
[profiles.<name>] |
launch or attach |
profiles |
top level | profiles by name |
program |
[profiles.<name>] |
what to debug. Required |
theme |
[ui] |
dark, light or system |
width |
[ui] |
initial window width in logical pixels |
height |
[ui] |
initial window height in logical pixels |
top_left |
[ui.layout] |
panels in the upper left zone |
ui |
top level | window settings |
version |
top level | config format version. Required |
Values that are not keys¶
Panel names¶
Used in [ui.layout], written exactly as the tabs read:
Threads · Call Stack · Variables · Watches · Evaluate · Logs ·
Inspector · Breakpoints
Keymap actions¶
Used in [ui.keymaps]:
| Group | Actions |
|---|---|
| Execution | continue, step_into, step_over, step_out, pause, terminate, restart |
| Panels | next_panel, previous_panel, focus_threads, focus_call_stack, focus_variables, focus_watches, focus_evaluate, focus_logs, focus_inspector, focus_breakpoints |
| Navigation | next_row, previous_row, top, bottom, collapse, expand, activate, delete_row, cancel |
| Variables search | search, search_next, search_previous, search_continue |
| Other | help |
Substitutions¶
| Token | Expands to | Valid in |
|---|---|---|
${root} |
the absolute project root | env, args, adapter_command, launch_arguments |
{out} |
the binary being built | build.args |
{program} |
what program names |
build.args |
launch_arguments keys the PHP adapter reads¶
| Key | What it is |
|---|---|
port |
the DBGp port to listen on; default 9003 |
sessionMode |
server or cli; default server |
pathMappings |
container path to host path |
testCommand |
command that runs PHPUnit, for the test-under-cursor flow |
Other adapters read their own keys; Bugsaur passes the body through unchanged.