Skip to content

tamnd/devdocs-cli

Repository files navigation

devdocs

Browse DevDocs.io programming documentation

devdocs is a single pure-Go binary. It speaks to devdocs over plain HTTPS, shapes the responses into clean records, and pipes into the rest of your tools. No API key, nothing to run alongside it.

Install

go install github.com/tamnd/devdocs-cli/cmd/devdocs@latest

Or grab a prebuilt binary from the releases, or run the container image:

docker run --rm ghcr.io/tamnd/devdocs:latest --help

Usage

devdocs --help
devdocs version

This is a fresh scaffold. The command tree starts with version; build out the real commands in cli/ on top of the devdocs library package.

Development

cmd/devdocs/   thin main, wires cli.Root into fang
cli/                 the cobra command tree
devdocs/                the library: HTTP client and data models
docs/                tago documentation site
make build      # ./bin/devdocs
make test       # go test ./...
make vet        # go vet ./...

Releasing

Push a version tag and GitHub Actions runs GoReleaser, which builds the archives, Linux packages, the multi-arch GHCR image, checksums, SBOMs, and a cosign signature:

git tag v0.1.0
git push --tags

The Homebrew and Scoop steps self-disable until their tokens exist, so the first release works with no extra secrets.

License

Apache-2.0. See LICENSE.

About

Browse DevDocs.io programming documentation entries and references from the terminal

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors