Two data sources
Fetch live metadata from the GitHub REST API, or build a card entirely offline from a local checkout — no network, no token.
shipcard
A stunning, shareable SVG card for any repository. Point it at owner/repo
and get back a polished card — the name, description, a colored language bar,
and star/fork counts — ready to drop into a README or serve as an Open Graph
social preview.
Every repo deserves a good first impression. GitHub’s default social image is
generic; a hand-made banner goes stale the moment your stack changes. shipcard
renders the card from live data, so it’s always current — and because it emits a
plain, self-contained SVG, it embeds anywhere and scales without blurring.
shipcard abdulmunimjemal/shipcard -o card.svg
Pure, embeddable SVG
The renderer is a pure function that returns a standalone <svg>. No native
dependencies, no headless browser — it works in any README, page, or
og:image.
Language bar, GitHub colors
The primary languages render as a rounded, color-coded bar with a legend, using the same canonical palette GitHub uses for its own language bars.
Themes & sizes
dark or light, and either the 1200×630 og social size or a compact
card. Pick the combination that fits where it lands.
Optional AI summary
Pass --summary to replace the description with a one-line, punchy blurb
from your own OpenAI-compatible endpoint. Off by default — no surprise API
calls.
Zero config
No config file, no setup. One command produces a card. Run it with npx
without installing anything.
Next steps
Section titled “Next steps” Quick start From install to a finished card in a few steps — GitHub and local modes.
CLI reference Every flag, both modes, the GITHUB_TOKEN, exit codes, and examples.
Customization Themes, sizes, the language color map, and the optional AI summary.
Programmatic API renderCard, computeLanguages, the color helpers, and the exported types.