Guide

Scripting

octoscope isn't only a TUI. Two flags fetch once, print, and exit — for quick checks, shell status-lines, cron jobs and pipelines.

--plain — a text summary

A static, human-readable digest of the same data the dashboard shows, printed to stdout. No alt-screen, no colour codes to fight with.

$ octoscope --plain
$ octoscope torvalds --plain     # anyone's public profile

--json — a stable contract

The same data as JSON, versioned (schema_version) and documented — so a script can depend on its shape. Fields are added additively, every list is always an array, and a breaking change bumps the version.

$ octoscope --json | jq '.social.total_stars'
$ octoscope --json --public-only > snapshot.json

Both honour --public-only and the usual auth cascade, and the two are mutually exclusive.