Releases: shidesheng0218/repo-ready
Release list
RepoReady v0.6.0 - CLI-first launch pack for AI coding agent readiness
RepoReady v0.6.0 focuses on making the project easier to understand, run, screenshot, and share.
Highlights
- CLI-first README for GitHub and npm discovery
- Screenshot-friendly report output with
--compactand--screenshot - Clean Agent Failure Risk, Evidence Chain, and Fix PR Plan sections
- Launch pack for V2EX, Reddit, Hacker News, X, 掘金, and 小红书
- Marketing assets for community posts
- Contributor templates and Good First Issue ideas
- README hero image and badge upgrades
- CI badge and Stars badge added
- README and Chinese encoding cleanup
Run
npx @shidesheng0218/repo-ready@latest
Chinese report
npx @shidesheng0218/repo-ready@latest --lang zh
Screenshot-friendly output
npx @shidesheng0218/repo-ready@latest --compact
Fix preview
npx @shidesheng0218/repo-ready@latest fix --dry-run
npx @shidesheng0218/repo-ready@latest fix --plan
Links
GitHub: https://github.com/shidesheng0218/repo-ready
npm: https://www.npmjs.com/package/@shidesheng0218/repo-readyv0.4.0 — Agent Failure Risk, Audit Evidence, and Explainable Fix PRs
RepoReady v0.4.0 — Agent Failure Risk, Audit Evidence, and Explainable Fix PRs
RepoReady is evolving from an AI coding agent readiness scanner into an AI Coding Agent Readiness Audit + Fix Platform.
This release focuses on making reports more trustworthy, fixes more reviewable, and the project more useful for repositories that want to work better with Codex, Claude Code, Cursor, and human contributors.
Install
npx @shidesheng0218/repo-ready@latest
Generate a Chinese report:
npx @shidesheng0218/repo-ready@latest --lang zh
Generate Markdown or JSON:
npx @shidesheng0218/repo-ready@latest --markdown
npx @shidesheng0218/repo-ready@latest --json
Preview fix plan:
npx @shidesheng0218/repo-ready@latest fix --plan
Preview generated fixes:
npx @shidesheng0218/repo-ready@latest fix --dry-run
What is RepoReady?
RepoReady helps your repository become more ready for:
Codex
Claude Code
Cursor
AI coding agents
Open-source contributors
It checks whether a repository has the instructions, validation commands, documentation, context quality, and safety boundaries needed for AI-assisted development.
Highlights
Agent Failure Risk
RepoReady now predicts where AI coding agents are most likely to fail inside a repository.
Risk categories include:
Context Confusion
Validation Gap
Safety Boundary Risk
Onboarding Gap
Scope Drift Risk
Each risk includes:
risk level
score
why agents may fail
evidence
mitigation
fixability
Audit-grade Evidence Chain
Reports now include stronger evidence fields:
status
severity
category
source
impact
fixability
suggested fix
This makes RepoReady reports more explainable and easier to trust.
Strategy Layer 2.0
RepoReady now provides a clearer strategic summary:
posture
risk level
readiness gap
evidence confidence
priority actions
automation boundary
growth plan
recommended path
The recommended path is split into:
Now
Next
Later
Explainable Fix PRs
Fix PRs are now more professional and easier to review.
Generated PR bodies include:
Why this PR exists
What RepoReady detected
Agent Failure Risks
What this PR changes
What needs human review
Suggested validation commands
Each generated change can include a reason and risk level.
Better Web Report Storytelling
The web report page now follows a clearer narrative:
Current State
Why Agents May Fail
Fix Path
Share / Growth
The goal is to make reports more useful, more shareable, and easier to understand.
Agent Ready Index
This release adds a generated Agent Ready Index article:
docs/agent-ready-index-2026-06.md
It includes:
executive summary
key findings
top repositories
common blockers
failure risk distribution
methodology
Chinese summary
launch copy for Hacker News, Reddit, X, V2EX, 掘金, and 知乎
Encoding Hardening
Fixed Chinese encoding issues in Markdown output and index article generation.
Added regression tests to prevent Chinese labels from becoming corrupted.
Commands
npx @shidesheng0218/repo-ready@latest
npx @shidesheng0218/repo-ready@latest --lang zh
npx @shidesheng0218/repo-ready@latest --markdown
npx @shidesheng0218/repo-ready@latest --json
npx @shidesheng0218/repo-ready@latest fix --plan
npx @shidesheng0218/repo-ready@latest fix --dry-run
Safety
RepoReady remains safe by default:
It does not execute repository scripts.
It does not upload private local source by default.
It only writes files when explicitly requested.
Fix PRs are reviewable and are not merged automatically.
Dangerous scripts are flagged for manual review.
Validation
This release was verified with:
npm run lint
node --test tests\core.test.js tests\advanced-report.test.js
npm run web:build
npm pack --dry-run --cache .\.npm-cache
Links
GitHub: https://github.com/shidesheng0218/repo-ready
npm: https://www.npmjs.com/package/@shidesheng0218/repo-ready
中文简介
RepoReady v0.4.0 将项目从“AI 编程代理适配扫描器”进一步升级为 AI 编程代理适配审计与修复平台。
这一版重点增强:
Agent 失败风险预测
审计级证据链
策略层 2.0
可解释 Fix PR
Web 报告页叙事
Agent Ready Index 传播报告
中文编码稳定性
RepoReady 的目标是帮助 GitHub 仓库更适合 Codex、Claude Code、Cursor 等 AI 编程代理协作,同时让项目更容易被贡献者理解和参与。v0.2.0 – Agent Ready Spec, Policy Layer, and Fix Plans
你在 GitHub Release 的 Write 里面直接复制下面这一整段即可:
# RepoReady v0.2.0
RepoReady v0.2.0 upgrades the project from an AI-agent repository scanner into an early **AI Agent Readiness infrastructure layer**.
RepoReady helps your repository become easier for Codex, Claude Code, Cursor, and human contributors to understand, validate, and safely modify.
## Install
```bash
npx @shidesheng0218/repo-ready@latestChinese report:
npx @shidesheng0218/repo-ready@latest --lang zhWhat's new
Agent Ready Spec
RepoReady now includes an Agent Ready Repository Standard.
npx @shidesheng0218/repo-ready@latest spec
npx @shidesheng0218/repo-ready@latest spec --lang zhThis defines what an AI-agent-ready repository should include:
- agent instructions
- install / dev / test / build / lint commands
- README onboarding
- safety boundaries
- clean repository context
- reviewable agent tasks
Policy Layer
RepoReady now supports policy initialization and policy checks.
Generate a default policy:
npx @shidesheng0218/repo-ready@latest policy initWrite policy config:
npx @shidesheng0218/repo-ready@latest policy init --writeCheck policy compliance:
npx @shidesheng0218/repo-ready@latest policy checkThis is the first step toward making RepoReady useful for teams that want enforceable readiness rules before AI coding agents modify repositories.
Fix Plan
RepoReady can now classify generated fixes into:
- safe automatic fixes
- fixes that need review
- manual-only fixes
Run:
npx @shidesheng0218/repo-ready@latest fix --planApply only safe automatic fixes:
npx @shidesheng0218/repo-ready@latest fix --apply-safeThis makes RepoReady safer and more practical for real repositories.
Existing features
RepoReady also includes:
- AI Agent Ready score
- Contributor Ready score
- Context Quality score
- Safety score
- Code Quality score
- evidence chain
- score breakdown
- bilingual reports
- doctor mode
- agent task generation
- context pack generation
- GitHub Action wrapper
- fix dry-run / write / branch / PR prototype
Example commands
npx @shidesheng0218/repo-ready@latest
npx @shidesheng0218/repo-ready@latest --lang zh
npx @shidesheng0218/repo-ready@latest doctor
npx @shidesheng0218/repo-ready@latest tasks
npx @shidesheng0218/repo-ready@latest context --dry-run
npx @shidesheng0218/repo-ready@latest fix --dry-run
npx @shidesheng0218/repo-ready@latest fix --plan
npx @shidesheng0218/repo-ready@latest policy checkWhy this release matters
AI coding agents work better when repositories provide clear instructions, validation commands, clean context, and safety boundaries.
RepoReady v0.2.0 moves toward becoming the preflight layer for AI coding agents:
Before an agent changes code, RepoReady checks whether the repository is understandable, testable, safe, and actionable.
中文一句话:
RepoReady 帮你把仓库整理成 AI 编程代理和真人贡献者都更容易理解、更容易验证、更安全协作的状态。
Links
GitHub:
https://github.com/shidesheng0218/repo-ready
npm:
https://www.npmjs.com/package/@shidesheng0218/repo-ready
v0.1.3
What's new
RepoReady is now more than a scanner. It can generate AI-agent collaboration outputs for your repository.
Added
-
repoready doctor- Diagnosis, strengths, risks, and recommended next step.
-
repoready tasks- Copy-ready prompts for Codex, Claude Code, Cursor, and other AI coding agents.
-
repoready context- Generates
.repo-ready/context/*files:project-map.mdcommands.mdsafety-boundaries.mdtask-suggestions.mdai-agent-brief.md
- Generates
Usage
npx @shidesheng0218/repo-ready@latest doctor --lang zh
npx @shidesheng0218/repo-ready@latest tasks --lang zh
npx @shidesheng0218/repo-ready@latest context --dry-run
Validation
10 tests passing
Published to npm as @shidesheng0218/repo-ready@0.1.3RepoReady v0.1.0
First public release of RepoReady.
RepoReady is an AI coding agent readiness checker and fixer for GitHub repositories.
It helps make repositories more suitable for Codex, Claude Code, Cursor, and other AI coding agents, while also making projects easier for contributors to understand and work with.
Quick Start
Run RepoReady in any repository:
npx @shidesheng0218/repo-ready
npx @shidesheng0218/repo-ready
Generate a Chinese report:
npx @shidesheng0218/repo-ready --lang zh
Generate Markdown output for GitHub summaries:
npx @shidesheng0218/repo-ready --markdown
Preview safe, reviewable fixes:
npx @shidesheng0218/repo-ready fix --dry-run
Global install:
npm install -g @shidesheng0218/repo-ready
repo-ready
repoready
What RepoReady Checks
- AGENTS.md, CLAUDE.md, and Cursor rules
- Test, build, dev, and lint commands
- README install / usage / test / contribution sections
- GitHub Actions workflows
- Issue templates and PR templates
- License and .env.example
- Context noise such as generated folders, caches, large files, and missing ignore rules
- Dangerous scripts such as destructive deletes, force pushes, database resets, and production deploys
Highlights
- AI agent readiness scan for Codex, Claude Code, Cursor, and similar coding agents
- Bilingual CLI reports in English and Chinese
- Weighted scoring with confidence
- Before/after baseline comparison
- Deep analysis for README quality, dependency health, safety boundaries, and task graph
- Fix generation for AGENTS.md, README sections, GitHub Actions, issue templates, badges, .gitignore, and .env.example
- GitHub Action wrapper
- Next.js Web report page
- Optional AI enhancement with user-provided API keys
Safety
RepoReady is designed to be safe by default.
- It does not execute repository scripts
- Local scans do not upload source code
- Fixes are dry-run by default
- Files are only written when the user explicitly runs fix --write or fix --branch
- AI enhancement is optional and disabled unless the user provides their own API key
Current Status
This is the first MVP release.
The core CLI, scoring engine, fix generator, GitHub Action wrapper, and Web report page are available.
Future releases will improve GitHub App integration, public report persistence, more language-specific rules, and richer Web reports.
Links
npm: https://www.npmjs.com/package/@shidesheng0218/repo-ready