History

Alessandro Arzilli cb91509630 terminal: send large output to pager (#3060 ) For commands that could produce large amounts of output switch to a pager command ($DELVE_PAGER, $PAGER or more) after a certain amount of output is produced. Fixes #919		2022-08-17 09:02:53 +02: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	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08: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	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_run.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_test.md	commmands: update DAP overview in help (#2850 )	2022-01-06 08:57:40 -08:00
dlv_trace.md	cmd/dlv,proc: misc improvements to trace subcommand (#3069 )	2022-07-22 08:57:57 -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