bdelanghe/Synoptic GitHub
Regenerate a profile README from your GitHub repositories, grouped by self-labeled topic. Bun.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | A token that can read your repositories. | yes | — |
| mode | render | validate | suggest | status. status writes a freshness-stamped fleet board (CI + open PRs/issues) instead of the README. | no | render |
| gh-user | Read this owner/org instead of the token owner (e.g. bounded-systems). Empty = the token owner. | no | "" |
| status-out | status mode: output file for the fleet board (a sibling .json is written too). | no | STATUS.md |
| beads-summary | status mode: optional org-backlog summary as JSON {"ready","blocked","open","url"?}. Compute it where a beads/issue daemon is reachable (NOT stateless CI) and pass it in; omitted/malformed = no backlog line. | no | "" |
| group-by | topic | language | none | no | topic |
| orgs | Comma-separated orgs whose public repos to include (e.g. bounded-systems) | no | "" |
| out | Output file to write. | no | README.md |
| thesis | One-paragraph thesis (your bet, in plain language); rendered as a lead blockquote under the bio. Empty = none. | no | "" |
| read-first | Funnel link: "Label | https://url" (or just a URL) -> a prominent "Start here" line. Empty = none. | no | "" |
| banner | Path prefix for a theme-aware SVG banner; emits <picture> with <prefix>-dark.svg / <prefix>-light.svg. Empty = no banner. | no | "" |
| featured | Comma-separated repo names to highlight in a Featured section (in order); pulled out of the topic groups. | no | "" |
| filter | Comma-separated topics to query: only repos carrying one of these topics are shown. Empty = all. | no | "" |
| inject-into | Region-injection: file to inject the grouped list into (between <!-- MARKER:start/end -->), preserving the rest. Overrides full-render. | no | "" |
| marker | Marker name for region-injection. | no | synoptic |
Outputs
no outputs