openf1-cli

openf1

A command line for openf1.

openf1 is a single pure-Go binary. It reads public openf1 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 openf1 as openf1:// URIs.

Install

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

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

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

Usage

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

Every command shares one output contract: -o table|markdown|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 color-aware 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 openf1 records in openf1/ and declare their operations in openf1/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:

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

Use it as a resource-URI driver

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

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

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

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

Development

cmd/openf1/   thin main: hands cli.NewApp to kit.Run
cli/                 assembles the kit App from the openf1 domain
openf1/                the library: HTTP client, data models, and domain.go (the driver)
docs/                tago documentation site

make build      # ./bin/openf1
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.