mirror of https://github.com/go-delve/delve.git synced 2025-10-27 20:23:41 +08:00

Files

Archana Ravindar e835184aff Add flag to retain trace directory after detach (#4091 )

* Add flag to retain trace directory after detach
Fixes https://github.com/go-delve/delve/issues/4079

* Addressing review comments

* To fix test errors coming in issue 4051

* Skip TestIssue4051 for rr backend

* Address remaining review comments

2025-09-10 11:50:46 -04:00

dlv_attach.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv_backend.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv_connect.md

cmd/dlv: support unix domain sockets (#3655 )

2024-02-07 11:04:45 -08:00

dlv_core.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv_dap.md

cmds/commands: Update 'client-addr' to support Unix domain sockets (#3819 )

2024-09-30 11:20:48 -07:00

dlv_debug.md

Add flag to retain trace directory after detach (#4091 )

2025-09-10 11:50:46 -04:00

dlv_exec.md

Add flag to retain trace directory after detach (#4091 )

2025-09-10 11:50:46 -04:00

dlv_log.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv_redirect.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv_replay.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv_run.md

cmd/dlv: support unix domain sockets (#3655 )

2024-02-07 11:04:45 -08:00

dlv_test.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv_trace.md

pkg/terminal,service/debugger: Support to add a new suboption --follow-calls to trace subcommand (#3594 )

2024-06-12 12:35:48 -07:00

dlv_version.md

service/rpc1: delete APIv1 (#3881 )

2024-12-16 12:30:47 -08:00

dlv.md

Documentation,cmd/dlv: clean up command line usage help (#3395 )

2023-08-09 10:37:55 -07: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