openverse-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

openverse

Search Creative Commons licensed images and audio via the OpenVerse API.

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

Install

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

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

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

Usage

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

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

Use it as a resource-URI driver

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

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

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

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

Development

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

Jump to

Keyboard shortcuts

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