History

Hyang-Ah Hana Kim 9ed4ba0c49 Documentation: correct the flag name used to configure log destination (#2464 ) The documentation mentions flags that do not exist. Replace them with the existing, --log-dest flag.		2021-05-04 08:39:01 +02:00
..
json-rpc	Fix broken link to JSON-RPC (#2348 )	2021-02-21 07:48:12 +01:00
ClientHowto.md	Documentation: correct the flag name used to configure log destination (#2464 )	2021-05-04 08:39:01 +02:00
README.md	documentation: API documentation improvements (#507 )	2016-04-24 10:18:02 -07:00

README.md

API Documentation

Delve exposes an API interface so that other programs, mostly IDEs and editors, can interact with Delve programmatically. The API is used by the terminal client, so will always stay up to date in lockstep regardless of new features.

Usage

In order to run Delve in "API mode", simply invoke with one of the standard commands, providing the --headless flag, like so:

$ dlv debug --headless --api-version=2 --log --listen=127.0.0.1:8181

This will start the debugger in a non-interactive mode, listening on the specified address, and will enable logging. The last two flags are optional, of course.

Optionally, you may also specify the --accept-multiclient flag if you would like to connect multiple clients to the API.

You can connect the headless debugger from Delve itself using the connect subcommand:

$ dlv connect 127.0.0.1:8181

This can be useful for remote debugging.

API Interfaces

Delve has been architected in such a way as to allow multiple client/server implementations. All of the "business logic" as it were is abstracted away from the actual client/server implementations, allowing for easy implementation of new API interfaces.

Current API Interfaces

JSON-RPC