Add the badge
Show your grade in your README. You add it; we never do.
Before you start
- A scan you’re happy to show: Scan in 60 seconds.
- A public GitHub repository, so shields.io can read the file.
1. Write the badge file
Section titled “1. Write the badge file”$ npx -y deedglass scan --badge --no-write…[](https://deedglass.com/score)--badge writes .deedglass/score.json, a shields.io endpoint file such as {"schemaVersion":1,"label":"agent blast radius","message":"C","color":"3F4453","cacheSeconds":3600}, and prints the Markdown line for your README. With a GitHub remote, the line has your owner, repo and branch filled in; without one, it has placeholders to replace.
2. Commit it yourself
Section titled “2. Commit it yourself”deedglass init writes .deedglass/* and !.deedglass/score.json to .gitignore: keys stay out of git and the badge file may go in. If your .gitignore has an older .deedglass/ line, the scan prints the two lines to use instead.
git add .deedglass/score.jsongit commit -m "Add the Deedglass blast-radius badge"Paste the printed line into your README and push. shields.io reads your own file, and caches it, so a new grade can take a few minutes to show. The badge links to deedglass.com/score, which explains what the grade means.
Share a result without a badge
Section titled “Share a result without a badge”deedglass scan --share prints a link, https://deedglass.com/s#v1.…. Everything after # stays in the browser: no server receives it. The link holds only the grade, the points, the finding counts, the finding ids and the deduction ids, never a path, a table, a host or a variable name.
What it doesn’t do
Section titled “What it doesn’t do”- Deedglass never adds a badge to anyone’s repo, and never opens a pull request, issue or comment to suggest one.
- The scan never runs git. Committing the file is your step.
- A grade is a snapshot of one machine’s setup when you ran the scan. Run it again after you change your configs.
- Scan in 60 seconds: what each deduction means.