Installation gives you the CLI. Linking GitHub proves which public work is yours. Agent wiring keeps progress fresh automatically while you use Codex, Claude, or another coding tool.
Installing alone does not identify your GitHub work. Complete the link step once; agent wiring is recommended automation.
1
Install with Bun
Install the published CLI globally so renown is available in every repository.
2
Authenticate GitHub
If gh auth status already succeeds, skip this. Renown uses GitHub CLI authentication; it never asks you to paste a token into the website.
3
Link your account
This uses your GitHub CLI authentication to associate your identity, verify public work, and pull the score and pets you have earned.
4
Wire Codex and Claude
This installs first-party hooks for both agents and a tmux HUD. Use an individual target if you only want one integration.
That’s enough.Run renown --help to explore the CLI, or keep coding and let the installed hooks refresh your progress. Re-run renown link when you intentionally add another GitHub identity. If linking reports playerId + token required, run renown upgrade and retry.
AGENT INTEGRATIONS
Same game, native wiring
Every integration reports the same three signals: a session starts, meaningful work happens, and a small HUD can show progress. The host-specific setup only decides where those signals plug in.
First-party automatic setup
Claude Code
Adds a native Claude status line that refreshes every five seconds.
Counts one Claude session at SessionStart and checks for Renown updates in the background.
Runs a heartbeat after each completed turn so agent progress, achievements, the HUD, and your submitted state stay current.
First-party hooks + optional tmux HUD
Codex
Enables Codex hooks, adds ~/.renown as a writable root, and preserves a backup of config.toml.
Counts one Codex session at SessionStart and runs a heartbeat after each completed turn.
Renown prints progress after turns; run `renown install-agent tmux` for a persistent bottom status bar.
If Codex prompts about new hooks, open /hooks and trust them.
Portable integration
Cursor, Copilot, Aider, Gemini & others
At session start, run `renown agent <provider> --quiet` using codex, claude, cursor, copilot, aider, gemini, goose, windsurf, openhands, devin, or other.
After substantive work or from a turn-ending hook, run `renown heartbeat`.
Use `renown statusline` for a command-backed footer, or display ~/.renown/hud.txt from file-backed UI chrome.
This contract is editor-agnostic: an integration only needs a session hook, a heartbeat hook, and optionally a status surface.
WHAT’S AVAILABLE
The useful commands
renown linkLink this install to your GitHub identity and pull verified progress.renown heartbeatRefresh agent progress, achievements, the local HUD, and submitted state.renown petShow your current avatar pet, animated in the terminal.renown rarestShow the rarest pet in your linked collection.renown switchList pets you own and choose a new avatar.renown boardShow the current repository’s leaderboard, or pass an owner/repo.renown weeklyReview seven-day attribution, score changes, and new achievements.renown statuslinePrint one compact line for terminal or agent chrome.renown upgradeCheck for and install the latest published version.
HOW IT WORKS
Local detail, public proof
The installed CLI keeps agent activity and the HUD on your machine while the server verifies public GitHub work for rankings, attribution, achievements, and pet ownership. A pet’s commit SHA is its deterministic seed: the same seed always produces the same creature. The Renown source checkout adds the richer local scoring engine and interactive TUI for contributors developing Renown itself.
AUTOMATE A REPOSITORY
Credit every contributor in CI
Add the Renown GitHub Action when a repository should refresh linked contributors after pushes. Unlinked contributors simply no-op and Renown does not fail their build.
- uses: absolutejs/renown@v1
READY
Pull your first collection.
Install with Bun, link GitHub, then open the game or keep working through your agent.