quran-cli

quran

A command line for quran.

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

Install

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

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

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

Usage

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

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

Use it as a resource-URI driver

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

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

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

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

Development

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

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