README.org
45 lines · 1593 bytes
1#+title: octosentry
2
3* what
4macos menu bar app. aggregates github security alerts (dependabot,
5code scanning, secret scanning) across your repos into one
6severity-ranked feed. deep-links out to github.com to act.
7
8* does
9- one feed across all three alert types on a single severity scale
10- source badge, repo, github severity label, one-line summary, age
11- click an alert to open it on github.com
12- errors and unavailable sources shown in the popover, not hidden
13- add or remove watched repos from the popover; a background poll
14 keeps the feed fresh while closed
15- sign in with github via device authorization; no password or
16 token typed into the app
17- no third-party dependencies. swiftui and urlsession.
18
19* requires
20macos 14 or later. a github account with access to the repos you
21watch.
22
23* use
241. build and run.
252. click the shield icon, Sign in with GitHub. you get a short
26 code; Open GitHub, enter it, authorize.
273. click the gear to add or remove repos (owner/repo).
284. click an alert to open it on github.com.
29
30an unavailable source usually means that alert type is disabled for
31the repo or your account lacks permission, not that something broke.
32device flow grants the security_events scope, which may not cover
33dependabot alerts on private repos.
34
35* build
36open octosentry.xcodeproj and run the octosentry scheme. targets
37macos 14, swift 6 strict concurrency, no package dependencies.
38
39* contributing
40- no third-party dependencies. hard constraint.
41- swift 6 strict concurrency stays on; new code compiles clean.
42- match the file-per-type layout.
43
44* license
450bsd. see LICENSE.