README
¶
dict
Look up word definitions, synonyms and phonetics
dict is a single pure-Go binary. It speaks to dictionary 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/dictionary-cli/cmd/dict@latest
Or grab a prebuilt binary from the releases, or run the container image:
docker run --rm ghcr.io/tamnd/dict:latest --help
Usage
dict --help
dict version
This is a fresh scaffold. The command tree starts with version; build out the
real commands in cli/ on top of the dictionary library package.
Development
cmd/dict/ thin main, wires cli.Root into fang
cli/ the cobra command tree
dictionary/ the library: HTTP client and data models
docs/ tago documentation site
make build # ./bin/dict
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli builds the dict command tree on top of the dictionary library.
|
Package cli builds the dict command tree on top of the dictionary library. |
|
cmd
|
|
|
dict
command
Command dict is a single-binary command line for dictionary.
|
Command dict is a single-binary command line for dictionary. |
|
Package dictionary is the library behind the dict command: the HTTP client, request shaping, and the typed data models for the Free Dictionary API.
|
Package dictionary is the library behind the dict command: the HTTP client, request shaping, and the typed data models for the Free Dictionary API. |
|
pkg
|
|
|
render
Package render turns slices of record structs into one of the output formats dictionary-cli supports: table, json, jsonl, csv, tsv, url, and raw.
|
Package render turns slices of record structs into one of the output formats dictionary-cli supports: table, json, jsonl, csv, tsv, url, and raw. |