Gapwise CLI

The Gapwise CLI is an open-source command-line interface for developers and campus data contributors. It queries the public API for university and campus discovery, buildings, residences, places, and routing. Its maintainer commands scaffold and validate integrations in sibling gapwise and data checkouts. It does not access a student’s private timetable or account.

Install and maintain

Use Node.js 22 or newer. The intended canonical npm identity is @gapwise/cli. The initial npm publication is pending owner authentication; the public GitHub installation is available now:

npm install -g github:GapwiseHQ/cli
gapwise --version
gapwise --help

Once the registry release is verified, install or upgrade with npm install -g @gapwise/cli. To upgrade the GitHub installation, rerun npm install -g github:GapwiseHQ/cli. Uninstall with npm uninstall -g @gapwise/cli. The CLI repository has the MIT license, tests, release workflow, and source history.

Discover universities and campuses

gapwise universities
gapwise campuses --university uoft
gapwise campuses --university carleton
gapwise campuses --university york

Gapwise currently supports 11 universities and 13 campus models. Discovery shows canonical IDs, names, and routing availability. Public campus queries require --university ID; otherwise the API’s historical U of T default could silently give the wrong edition’s data. --campus selects one of that university’s campus IDs; omitting it uses that university’s default campus.

Query public campus facts

gapwise buildings --university carleton --query library
gapwise residences --university york --limit 10
gapwise buildings --university tmu --category academic
gapwise places --university uoft --campus utm --kind study
gapwise route --university carleton --from TB --to ML

The CLI reports empty results when a campus has no matching public records. Routing is refused when the selected campus is not routable; route results retain API warnings and verification status. Place availability and route coverage are source dependent.

For scripts, add --json to print the full { data, meta } response to stdout. Errors go to stderr and set a nonzero exit code:

gapwise buildings --university carleton --query library --json

The CLI is intentionally a thin public API client. For pagination, advanced queries, application integrations, and all public v1 operations, use the API reference or official SDKs.

University integration tooling

Clone cli, gapwise, and data as sibling repositories. Pass their parent directory with --workspace PATH or GAPWISE_WORKSPACE if they are elsewhere. App validation and development also require the runtimes used by those repositories, including Bun.

gapwise university create example-university --name "Example University" --dry-run
gapwise university validate carleton
gapwise university test carleton
gapwise university dev carleton
gapwise data validate carleton

The scaffold starts inactive with empty campus data and a deliberately unimplemented timetable adapter. Review source rights and evidence before activation. See Add a university for the full workflow.

Gapwise is an independent project and is not affiliated with or endorsed by the supported universities.