Reference
CLI flags
Run octoscope for your own dashboard, or octoscope <username> for anyone's public profile. Flags override the config file for that run.
$ octoscope [flags] [username]
--refresh DUR | Auto-refresh interval (Go duration: 30s, 1m). Floored at 5s. |
--compact | Dense card layout in the Overview tab. |
--public-only | Hide private repos / PRs / issues from the lists. |
--no-sponsor | Skip the sponsor splash for this run. |
--no-color | Force the zero-chroma monochrome theme (also honoured via NO_COLOR). |
--theme NAME | Pick a palette. See Themes. |
--config PATH | Read config from PATH instead of the default location. |
-v · --version | Print the version and exit. |
-h · --help | Print usage and exit. |
Run modes — print and exit
Four flags never open the TUI. They fetch (or read) once, print, and exit — and two more choose what that report includes:
--theme list | Preview every palette with a colour swatch. No fetch, no auth. |
--plain | A static, human-readable summary. See Scripting. |
--json | The versioned JSON contract for piping. |
--scan | Supply-chain sweep: the default branch of every repository you own or watch, then a report. Text, or JSON with --json. See Scripting. |
--activity | Add the recent-activity feed to the --plain / --json report. Opt-in: one extra API request. |
--inbox | Add your unread notification inbox to the report. Opt-in, your own inbox only, and it needs a classic token. |
!
--plain and --json are mutually exclusive, and neither combines with --theme list. --activity and --inbox need one of them — on their own they are a usage error, not a no-op, because the TUI shows those tabs regardless — and --inbox refuses a username, since the inbox is always the token's own. --scan refuses a username too — it sweeps your repositories — and does not combine with --activity, --inbox or --theme list. An unknown flag exits with a usage error.