delve/Documentation/cli

Commands

Command	Description
args	Print function arguments.
break	Sets a breakpoint.
breakpoints	Print out info for active breakpoints.
check	Creates a checkpoint at the current position.
checkpoints	Print out info for existing checkpoints.
clear	Deletes breakpoint.
clear-checkpoint	Deletes checkpoint.
clearall	Deletes multiple breakpoints.
condition	Set breakpoint condition.
config	Changes configuration parameters.
continue	Run until breakpoint or program termination.
disassemble	Disassembler.
exit	Exit the debugger.
frame	Executes command on a different frame.
funcs	Print list of functions.
goroutine	Shows or changes current goroutine
goroutines	List program goroutines.
help	Prints the help message.
list	Show source code.
locals	Print local variables.
next	Step over to next source line.
on	Executes a command when a breakpoint is hit.
print	Evaluate an expression.
regs	Print contents of CPU registers.
restart	Restart process from a checkpoint or event.
rewind	Run backwards until breakpoint or program termination.
set	Changes the value of a variable.
source	Executes a file containing a list of delve commands
sources	Print list of source files.
stack	Print stack trace.
step	Single step through program.
step-instruction	Single step a single cpu instruction.
stepout	Step out of the current function.
thread	Switch to the specified thread.
threads	Print out info for every traced thread.
trace	Set tracepoint.
types	Print list of types
vars	Print package variables.
whatis	Prints type of an expression.

args

Print function arguments.

[goroutine <n>] [frame <m>] args [-v] [<regex>]

If regex is specified only function arguments with a name matching it will be returned. If -v is specified more information about each function argument will be shown.

break

Sets a breakpoint.

break [name] <linespec>

See Documentation/cli/locspec.md for the syntax of linespec.

See also: "help on", "help cond" and "help clear"

Aliases: b

breakpoints

Print out info for active breakpoints.

Aliases: bp

check

Creates a checkpoint at the current position.

checkpoint [where]

Aliases: checkpoint

checkpoints

Print out info for existing checkpoints.

clear

Deletes breakpoint.

clear <breakpoint name or id>

clear-checkpoint

Deletes checkpoint.

clear-checkpoint <id>

Aliases: clearcheck

clearall

Deletes multiple breakpoints.

clearall [<linespec>]

If called with the linespec argument it will delete all the breakpoints matching the linespec. If linespec is omitted all breakpoints are deleted.

condition

Set breakpoint condition.

condition <breakpoint name or id> <boolean expression>.

Specifies that the breakpoint or tracepoint should break only if the boolean expression is true.

Aliases: cond

config

Changes configuration parameters.

config -list

Show all configuration parameters.

config -save

Saves the configuration file to disk, overwriting the current configuration file.

config <parameter> <value>

Changes the value of a configuration parameter.

config subistitute-path <from> <to>
config subistitute-path <from>

Adds or removes a path subistitution rule.

config alias <command> <alias>
config alias <alias>

Defines as an alias to or removes an alias.

continue

Run until breakpoint or program termination.

Aliases: c

disassemble

Disassembler.

[goroutine <n>] [frame <m>] disassemble [-a <start> <end>] [-l <locspec>]

If no argument is specified the function being executed in the selected stack frame will be executed.

-a <start> <end>	disassembles the specified address range
-l <locspec>		disassembles the specified function

Aliases: disass

exit

Exit the debugger.

Aliases: quit q

frame

Executes command on a different frame.

frame <frame index> <command>.

funcs

Print list of functions.

funcs [<regex>]

If regex is specified only the functions matching it will be returned.

goroutine

Shows or changes current goroutine

goroutine
goroutine <id>
goroutine <id> <command>

Called without arguments it will show information about the current goroutine. Called with a single argument it will switch to the specified goroutine. Called with more arguments it will execute a command on the specified goroutine.

goroutines

List program goroutines.

goroutines [-u (default: user location)|-r (runtime location)|-g (go statement location)]

Print out info for every goroutine. The flag controls what information is shown along with each goroutine:

-u	displays location of topmost stackframe in user code
-r	displays location of topmost stackframe (including frames inside private runtime functions)
-g	displays location of go instruction that created the goroutine

If no flag is specified the default is -u.

help

Prints the help message.

help [command]

Type "help" followed by the name of a command for more information about it.

Aliases: h

list

Show source code.

[goroutine <n>] [frame <m>] list [<linespec>]

Show source around current point or provided linespec.

Aliases: ls

locals

Print local variables.

[goroutine <n>] [frame <m>] locals [-v] [<regex>]

The name of variables that are shadowed in the current scope will be shown in parenthesis.

If regex is specified only local variables with a name matching it will be returned. If -v is specified more information about each local variable will be shown.

next

Step over to next source line.

Aliases: n

on

Executes a command when a breakpoint is hit.

on <breakpoint name or id> <command>.

Supported commands: print, stack and goroutine)

print

Evaluate an expression.

[goroutine <n>] [frame <m>] print <expression>

See Documentation/cli/expr.md for a description of supported expressions.

Aliases: p

regs

Print contents of CPU registers.

regs [-a]

Argument -a shows more registers.

restart

Restart process from a checkpoint or event.

restart [event number or checkpoint id]

Aliases: r

rewind

Run backwards until breakpoint or program termination.

Aliases: rw

set

Changes the value of a variable.

[goroutine <n>] [frame <m>] set <variable> = <value>

See Documentation/cli/expr.md for a description of supported expressions. Only numerical variables and pointers can be changed.

source

Executes a file containing a list of delve commands

source <path>

sources

Print list of source files.

sources [<regex>]

If regex is specified only the source files matching it will be returned.

stack

Print stack trace.

[goroutine <n>] [frame <m>] stack [<depth>] [-full] [-g] [-s] [-offsets]

-full		every stackframe is decorated with the value of its local variables and arguments.
-offsets	prints frame offset of each frame

Aliases: bt

step

Single step through program.

Aliases: s

step-instruction

Single step a single cpu instruction.

Aliases: si

stepout

Step out of the current function.

thread

Switch to the specified thread.

thread <id>

Aliases: tr

threads

Print out info for every traced thread.

trace

Set tracepoint.

trace [name] <linespec>

A tracepoint is a breakpoint that does not stop the execution of the program, instead when the tracepoint is hit a notification is displayed. See Documentation/cli/locspec.md for the syntax of linespec.

See also: "help on", "help cond" and "help clear"

Aliases: t

types

Print list of types

types [<regex>]

If regex is specified only the types matching it will be returned.

vars

Print package variables.

vars [-v] [<regex>]

If regex is specified only package variables with a name matching it will be returned. If -v is specified more information about each package variable will be shown.

whatis

Prints type of an expression.

	whatis <expression>.