noaa-tides-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

noaa-tides

A command line for noaa-tides.

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

Install

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

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

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

Usage

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

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

Use it as a resource-URI driver

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

import _ "github.com/tamnd/noaa-tides-cli/noaa-tides"

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

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

Development

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

Jump to

Keyboard shortcuts

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