Skip to content

tamnd/chesscom-cli

Repository files navigation

chesscom

A command line for chesscom.

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

Install

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

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

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

Usage

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

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

Use it as a resource-URI driver

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

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

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

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

Development

cmd/chesscom/   thin main: hands cli.NewApp to kit.Run
cli/                 assembles the kit App from the chesscom domain
chesscom/                the library: HTTP client, data models, and domain.go (the driver)
docs/                tago documentation site
make build      # ./bin/chesscom
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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors