jolpiaf1-cli

module
v0.1.0 Latest Latest
Warning

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

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

README

jolpiaf1

A command line for jolpiaf1.

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

Install

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

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

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

Usage

jolpiaf1 page <path>                      # fetch one page as a record
jolpiaf1 page <path> -o json              # as JSON, ready for jq
jolpiaf1 page <path> --template '{{.Body}}'  # just the readable body text
jolpiaf1 links <path>                     # the pages it links to, one per line
jolpiaf1 --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 jolpiaf1 records in jolpiaf1/ and declare their operations in jolpiaf1/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:

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

Use it as a resource-URI driver

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

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

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

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

Development

cmd/jolpiaf1/   thin main: hands cli.NewApp to kit.Run
cli/                 assembles the kit App from the jolpiaf1 domain
jolpiaf1/                the library: HTTP client, data models, and domain.go (the driver)
docs/                tago documentation site
make build      # ./bin/jolpiaf1
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 jolpiaf1 command tree from the jolpiaf1 domain on top of the any-cli/kit framework.
Package cli assembles the jolpiaf1 command tree from the jolpiaf1 domain on top of the any-cli/kit framework.
cmd
jolpiaf1 command
Command jolpiaf1 is a single-binary command line for jolpiaf1.
Command jolpiaf1 is a single-binary command line for jolpiaf1.
Package jolpiaf1 is the library behind the jolpiaf1 command line: the HTTP client, request shaping, and typed data models for the Jolpica F1 API (https://api.jolpi.ca/ergast/f1/), an open-source mirror of the Ergast Formula 1 API.
Package jolpiaf1 is the library behind the jolpiaf1 command line: the HTTP client, request shaping, and typed data models for the Jolpica F1 API (https://api.jolpi.ca/ergast/f1/), an open-source mirror of the Ergast Formula 1 API.

Jump to

Keyboard shortcuts

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