DOCUDEX GitHub Releases X
Go API reference aggregator v0.1.0

DOCUDEX

Go docs for the exact versions in your go.mod. Search from the terminal. Works offline.

$ brew install --cask aureliushq/tap/docudex

Free and open source. View on GitHub → 

$ docudex init
OK read      go.mod     38 direct deps + std
OK fetched   -> ~/.docudex/store
OK wrote     docudex.toml

$ docudex search "context.WithTimeout"

context · WithTimeout(parent Context, timeout Duration) (Context, CancelFunc)
  Returns a copy of the parent context with the deadline adjusted …

net/http · Server.Shutdown(ctx Context) error
  Gracefully shuts down the server without interrupting connections …

2 results across 38 docsets · 6ms
01

FEATURES

  1. 01 Version-exact

    The precise module@version in your go.mod. Not whatever pkg.go.dev shows today.

  2. 02 Scoped

    Only your dependencies and the standard library. No noise.

  3. 03 Offline

    Fetch once. Search anywhere after.

  4. 04 Terminal or browser

    docudex search for answers, docudex serve for a local web UI.

  5. 05 Real source

    Built from module source with go/doc. Never scraped.

  6. 06 Single binary

    Pure Go, no CGO, web UI embedded.

02

CONFIG

Commit docudex.toml. Teammates run docudex sync and get the same docs. 

# docudex.toml
[[docset]]
module  = "github.com/spf13/cobra"
version = "v1.8.1"

[[docset]]
module  = "github.com/charmbracelet/fang"
version = "v0.2.0"
03

GET STARTED

$ curl -fsSL https://raw.githubusercontent.com/aureliushq/docudex/main/install.sh | sh
$ docudex init
$ docudex serve
serving docs on http://localhost:8080

Docs and more install options in the README.