History

Alessandro Arzilli 84b757ad57 cmd/dlv,service/dap: use randomized name as default output binary (#3366 ) Using a fixed path as the default output binary means that executing Delve twice in the same directory will cause the second invocation to overwrite the output binary of the first instance of Delve, making the restart command not work correctly. Fixes #3345		2023-05-16 09:36:15 -07:00
..
dlv_attach.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_backend.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_connect.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_core.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_dap.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_debug.md	cmd/dlv,service/dap: use randomized name as default output binary (#3366 )	2023-05-16 09:36:15 -07:00
dlv_exec.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_log.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_redirect.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_replay.md	cmd/dlv: Add flag to replay for rr onprocess pid (#3281 )	2023-03-01 11:28:32 -08:00
dlv_run.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_test.md	cmd/dlv,service/dap: use randomized name as default output binary (#3366 )	2023-05-16 09:36:15 -07:00
dlv_trace.md	cmd/dlv,service/dap: use randomized name as default output binary (#3366 )	2023-05-16 09:36:15 -07:00
dlv_version.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
README.md	terminal: send large output to pager (#3060 )	2022-08-17 09:02:53 +02:00

README.md

Using Delve

You can invoke Delve in multiple ways, depending on your usage needs. Delve makes every attempt to be user-friendly, ensuring the user has to do the least amount of work possible to begin debugging their program.

The available commands can be grouped into the following categories:

Specify target and start debugging with the default terminal interface:
Trace target program execution
- dlv trace [package] <regexp>
Start a headless backend server only and connect with an external frontend client:
- dlv --headless <command> <target> <args>
  - starts a server, enters a debug session for the specified target and waits to accept a client connection over JSON-RPC or DAP
  - <command> can be any of debug, test, exec, attach, core or replay
  - if --headless flag is not specified the default terminal client will be automatically started instead
  - compatible with dlv connect, VS Code Go, GoLand
- dlv dap
  - starts a DAP-only server and waits for a DAP client connection to specify the target and arguments
  - compatible with VS Code Go
  - NOT compatible with dlv connect, GoLand
- dlv connect <addr>
  - starts a terminal interface client and connects it to a running headless server over JSON-RPC
Help information

The above list may be incomplete. Refer to the auto-generated complete usage document to further explore all available commands.

Environment variables

Delve also reads the following environment variables:

$DELVE_EDITOR is used by the edit command (if it isn't set the $EDITOR variable is used instead)
$DELVE_PAGER is used by commands that emit large output (if it isn't set the $PAGER variable is used instead, if neither is set more is used)
$TERM is used to decide whether or not ANSI escape codes should be used for colorized output
$DELVE_DEBUGSERVER_PATH is used to locate the debugserver executable on macOS