encode-cli

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2026 License: Apache-2.0

README

encode

A command line for encode.

encode is a single pure-Go binary. It reads public encode data over plain HTTPS, shapes it into clean records, and prints output that pipes into the rest of your tools. No API key, nothing to run alongside it.

The same package is also a resource-URI driver, so a host program like ant can address encode as encode:// URIs.

Install

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

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

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

Usage

encode page <path>                      # fetch one page as a record
encode page <path> -o json              # as JSON, ready for jq
encode page <path> --template '{{.Body}}'  # just the readable body text
encode links <path>                     # the pages it links to, one per line
encode --help                           # the whole command tree

Every command shares one output contract: -o table|json|jsonl|csv|tsv|url|raw, --fields to pick columns, --template for a custom line, and -n to limit. The default adapts to where output goes (a table on a terminal, JSONL in a pipe), so the same command reads well by hand and parses cleanly downstream.

This is a fresh scaffold. It ships one example resource type, page, wired end to end. Model the real encode records in encode/ and declare their operations in encode/domain.go; each one becomes a command, an HTTP route, and an MCP tool at once.

Serve it

The same operations are available over HTTP and as an MCP tool set for agents, with no extra code:

encode serve --addr :7777    # GET /v1/page/<path>  returns NDJSON
encode mcp                   # speak MCP over stdio

Use it as a resource-URI driver

encode registers a encode domain the way a program registers a database driver with database/sql. A host enables it with one blank import:

import _ "github.com/tamnd/encode-cli/encode"

Then ant (or any program that links the package) dereferences encode:// URIs without knowing anything about encode:

ant get encode://page/<path>   # fetch the record
ant cat encode://page/<path>   # just the body text
ant ls  encode://page/<path>   # the pages it links to, each addressable
ant url encode://page/<path>   # the live https URL

Development

cmd/encode/   thin main: hands cli.NewApp to kit.Run
cli/                 assembles the kit App from the encode domain
encode/                the library: HTTP client, data models, and domain.go (the driver)
docs/                tago documentation site
make build      # ./bin/encode
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 assembles the encode command tree from the encode domain on top of the any-cli/kit framework.
Package cli assembles the encode command tree from the encode domain on top of the any-cli/kit framework.
cmd
encode command
Command encode is a single-binary command line for encode.
Command encode is a single-binary command line for encode.
Package encode is the library behind the encode command line: the HTTP client, request shaping, and the typed data models for the ENCODE (Encyclopedia of DNA Elements) Project.
Package encode is the library behind the encode command line: the HTTP client, request shaping, and the typed data models for the ENCODE (Encyclopedia of DNA Elements) Project.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL