godoc

Show documentation for go packages.

Install

All systems
curl cmd.cat/godoc.sh
Debian Debian
apt-get install golang-golang-x-tools
Ubuntu
apt-get install golang-golang-x-tools
Arch Arch Linux
pacman -S golang-godoc-1
image/svg+xml Kali Linux
apt-get install golang-golang-x-tools
Fedora
dnf install golang-godoc-1
Raspbian
apt-get install golang-golang-x-tools

Show documentation for go packages.

  • Display help for package "fmt":
    godoc fmt
  • Display help for the function "Printf" of "fmt" package:
    godoc fmt Printf
  • Serve documentation as a web server on port "6060":
    godoc -http=:6060
  • Create an index file:
    godoc -write_index -index_files=path/to/file
  • Use the given index file to search the docs:
    godoc -http=:6060 -index -index_files=path/to/file

© tl;dr; authors and contributors