delve/Documentation/installation
Alessandro Arzilli 780bcac9cc
Documentation: update install instructions (#2352)
Remove OS specific install instructions that all repeat the same thing.
Since `go get ...` is being deprecated (to install executables)
recommend an install procedure that works on all supported versions of
go (`git clone && go install`) but also mention the new `go install`
mode in 1.16.
2021-02-21 11:04:55 -08:00
..
freebsd Documentation: update install instructions (#2352) 2021-02-21 11:04:55 -08:00
linux Documentation: update install instructions (#2352) 2021-02-21 11:04:55 -08:00
osx Documentation: update install instructions (#2352) 2021-02-21 11:04:55 -08:00
windows Documentation: update install instructions (#2352) 2021-02-21 11:04:55 -08:00
README.md Documentation: update install instructions (#2352) 2021-02-21 11:04:55 -08:00

Installation

Clone the git repository and build:

$ git clone https://github.com/go-delve/delve
$ cd delve
$ go install github.com/go-delve/delve/cmd/dlv

On Go version 1.16 or later, this command will also work:

$ go install github.com/go-delve/delve/cmd/dlv@latest

See go help install for details on where the dlv executable is saved.

If during the install step you receive an error similar to this:

found packages native (proc.go) and your_operating_system_and_architecture_combination_is_not_supported_by_delve (support_sentinel.go) in /home/pi/go/src/github.com/go-delve/delve/pkg/proc/native

It means that your combination of operating system and CPU architecture is not supported, check the output of go version.

macOS considerations

On macOS make sure you also install the command line developer tools:

$ xcode-select --install

If you didn't enable Developer Mode using Xcode you will be asked to authorize the debugger every time you use it. To enable Developer Mode and only have to authorize once per session use:

sudo /usr/sbin/DevToolsSecurity -enable

Compiling macOS native backend

You do not need the macOS native backend and it has known problems. If you still want to build it:

  1. Run xcode-select --install
  2. On macOS 10.14 manually install the legacy include headers by running /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg
  3. Clone the repo into $GOPATH/src/github.com/go-delve/delve
  4. Run make install in that directory (on some versions of macOS this requires being root, the first time you run it, to install a new certificate)

The makefile will take care of creating and installing a self-signed certificate automatically.