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

ossucs

Browse the Open Source Society University Computer Science curriculum from the command line.

ossucs is a single pure-Go binary. It reads the OSSU CS curriculum from GitHub 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 ossucs as ossucs:// URIs.

Install

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

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

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

Usage

ossucs courses                          # list all ~54 courses in the OSSU CS curriculum
ossucs courses -o json                  # as JSON, ready for jq
ossucs courses -o csv                   # as CSV for spreadsheets
ossucs courses --fields section,title   # pick columns
ossucs courses -n 10                    # first 10 courses
ossucs --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.

Serve it

The same operations are available over HTTP and as an MCP tool set for agents, with no extra code:

ossucs serve --addr :7777    # GET /v1/courses  returns NDJSON
ossucs mcp                   # speak MCP over stdio

Use it as a resource-URI driver

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

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

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

ant ls ossucs://course   # list all courses

Development

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

Jump to

Keyboard shortcuts

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