jokeapi-cli

module
v0.1.3 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

jokeapi

A command line for jokeapi.

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

Install

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

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

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

Usage

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

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

Use it as a resource-URI driver

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

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

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

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

Development

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

Jump to

Keyboard shortcuts

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