GitHub Share Card

Generate polished GitHub repository preview cards from a GitHub repository URL.

The card style is a clean white GitHub repo preview: owner/repo title, first contributor avatar, repository description, stats, and a language color bar.

npx

After publishing to npm:

npx github-share-card https://github.com/PRIS-CV/DataEvolver --out repo-card.png

Directly from this GitHub repo:

npx github:Kamisato520/github_share_card https://github.com/PRIS-CV/DataEvolver --out repo-card.png

Project-specific middle metric example:

npx github:Kamisato520/github_share_card PRIS-CV/DataEvolver --out dataevolver-card.png --middle-value 24 --middle-label Actions

The CLI uses the bundled Python generator. Install Pillow if your Python environment does not already have it:

python -m pip install pillow

Codex / Claude Code Plugin

This repository includes a repo-local Codex plugin marketplace:

.agents/plugins/marketplace.json
plugins/github-share-card/.codex-plugin/plugin.json
plugins/github-share-card/skills/github-repo-card/SKILL.md

Install the marketplace from a local clone:

git clone git@github.com:Kamisato520/github_share_card.git
cd github_share_card
codex plugin marketplace add .
codex plugin add github-share-card@github-share-card

Then start a new Codex/Claude Code thread and ask:

Use $github-repo-card to generate a README card for https://github.com/PRIS-CV/DataEvolver.

Avatar Fallback

The generator first tries to use the first public contributor returned by GitHub. If GitHub API access is rate-limited or no contributor avatar can be downloaded, it falls back to the repository owner avatar. If that also fails, the card uses a default GitHub icon.

Output

The script writes:

• the PNG card at --out
• the downloaded avatar beside the card as <card-name>-avatar.jpg
• JSON metadata on stdout, including a README markdown snippet

License

MIT