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

orcid

Fetch researcher profiles from the ORCID public registry.

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

Install

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

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

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

Usage

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

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

Use it as a resource-URI driver

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

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

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

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

Development

cmd/orcid/   thin main: hands cli.NewApp to kit.Run
cli/                 assembles the kit App from the orcid domain
orcid/                the library: HTTP client, data models, and domain.go (the driver)
docs/                tago documentation site
make build      # ./bin/orcid
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 orcid command tree from the orcid domain on top of the any-cli/kit framework.
Package cli assembles the orcid command tree from the orcid domain on top of the any-cli/kit framework.
cmd
orcid command
Command orcid is a single-binary command line for orcid.
Command orcid is a single-binary command line for orcid.
domain.go exposes orcid as a kit Domain: a driver that a multi-domain host (ant) enables with a single blank import,
domain.go exposes orcid as a kit Domain: a driver that a multi-domain host (ant) enables with a single blank import,

Jump to

Keyboard shortcuts

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