Skip to content

README badge + supermodel share command #52

@greynewell

Description

@greynewell

Problem

supermodel audit produces a rich health report that dies in a terminal. There's no way to share it, link to it, or display codebase health status in a GitHub repo. Every repo that adopts Supermodel should advertise it.

Solution

1. README badge

A dynamic badge served from the Supermodel API showing codebase health:

```markdown
Supermodel
```

Returns a shields.io-compatible SVG: codebase: HEALTHY (green) / DEGRADED (yellow) / CRITICAL (red).

2. supermodel share command

Run supermodel audit (or use the cached last result) and upload the report to a public URL:

```
$ supermodel share
Uploading audit report…
https://supermodeltools.com/s/abc123

Add to your README:
Supermodel
```

The share URL shows a read-only rendered version of the health report. Expires after 30 days unless the user pins it.

Why this matters

Every repo with the badge is permanent free distribution. The share URL makes audit results tweet-able — "just found 47 dead functions and 3 circular deps in my codebase with @supermodeltools".

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions