Skillget

repo-ready

agent
Security Audit
Warn
Health Warn
  • License — License: MIT
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Low visibility — Only 5 GitHub stars
Code Warn
  • network request — Outbound network request in apps/web/app/components/FixPrButton.jsx
  • process.env — Environment variable access in apps/web/app/layout.jsx
  • process.env — Environment variable access in apps/web/app/lib/repoready-server.js
  • network request — Outbound network request in apps/web/app/lib/repoready-server.js
Permissions Pass
  • Permissions — No dangerous permissions requested

No AI report is available for this listing yet.

SUMMARY

Make your repo ready for Codex, Claude Code, Cursor, and contributors.

README.md

RepoReady

npm
CI
Stars
License
Node
Platform

Make your repo ready for Codex, Claude Code, Cursor, and contributors.

一行命令检查你的仓库是否适合 AI 编程代理协作。

npx @shidesheng0218/repo-ready@latest

RepoReady CLI preview

RepoReady is a CLI-first AI coding agent readiness checker and fixer. It scans your repository, explains why agents may fail, and generates a reviewable fix plan. No server, no login, no AI API key, and no repository scripts are executed.

Quick Start

macOS / Linux / Windows

npx @shidesheng0218/repo-ready@latest

Windows PowerShell:

npx.cmd @shidesheng0218/repo-ready@latest

Chinese report

npx @shidesheng0218/repo-ready@latest --lang zh

Screenshot-friendly output

npx @shidesheng0218/repo-ready@latest --compact

Fix plan and dry run

npx @shidesheng0218/repo-ready@latest fix --plan
npx @shidesheng0218/repo-ready@latest fix --dry-run

Example output

RepoReady Report - my-repo

Overall Score        82/100
Agent Ready          70/100
Safety               92/100

Agent Failure Risk
HIGH     Validation Gap
MEDIUM   Scope Drift
LOW      Safety Boundary

Evidence Chain
PASS     AGENTS.md detected
PASS     Test command detected
REVIEW   README contribution section missing

PR-ready Fixes
+ AGENTS.md
+ README.md
+ .github/workflows/repoready.yml

Next
npx @shidesheng0218/repo-ready@latest fix --dry-run

What RepoReady checks

Area Checks
Agent instructions AGENTS.md, CLAUDE.md, .cursor/rules
Validation test, build, lint, typecheck commands
README quality install, usage, test, contribution, demo signals
CI / workflow GitHub Actions and verification workflow
Context quality generated files, caches, large files, ignored folders
Safety dangerous scripts, force push, DB reset, production deploys
Code quality tests, checks, lockfiles, CI, source structure

Why developers use it

Capability What it gives you
Agent Failure Risk Predicts why Codex, Claude Code, Cursor, or similar agents may fail in your repo.
Audit Evidence Chain Shows the signals behind every score, not just a black-box number.
Fix PR Plan Groups generated fixes into safe, review-required, and manual-only work.

Fix workflow

RepoReady is conservative by default. It previews changes before writing.

npx @shidesheng0218/repo-ready@latest fix --plan
npx @shidesheng0218/repo-ready@latest fix --dry-run
npx @shidesheng0218/repo-ready@latest fix --apply-safe
npx @shidesheng0218/repo-ready@latest fix --write
npx @shidesheng0218/repo-ready@latest fix --branch
npx @shidesheng0218/repo-ready@latest fix --pr --base main

Fix groups:

Group Meaning
Safe automatic fixes Low-risk files such as AGENTS.md, .gitignore, .env.example
Review-required fixes README, CI, templates, workflow changes
Manual-only boundaries database, auth, payment, deployment, secrets, destructive scripts

Output formats

npx @shidesheng0218/repo-ready@latest --json
npx @shidesheng0218/repo-ready@latest --markdown

Safety and privacy

  • RepoReady does not execute repository scripts.
  • Local scans do not upload private source code by default.
  • Files are only written when you explicitly use write/apply commands.
  • Dangerous scripts are flagged, not executed.
  • AI enhancement is optional. No API key means no AI call and no AI cost.

GitHub Action

name: RepoReady

on:
  pull_request:
  push:

jobs:
  repoready:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ./packages/action
        with:
          language: en
          min-score: 70

Optional web reports

RepoReady is CLI-first. The web report is optional and can be self-hosted.

You do not need a domain, server, database, OAuth, or GitHub App to use RepoReady locally.

Optional web capabilities:

/r/[owner]/[repo]
/badge/[owner]/[repo].svg
/share-card/[owner]/[repo].svg
/api/fix-pr

Looking for contributors

Good first issues:

  • Add Python framework detection rules
  • Add Rust readiness checks
  • Add Go project detection
  • Improve dangerous script detection
  • Improve README scoring for non-English projects

See CONTRIBUTING.md and docs/launch-pack.md for contribution and launch details.

Local development

git clone https://github.com/shidesheng0218/repo-ready.git
cd repo-ready
node packages/cli/bin/repoready.js
node packages/cli/bin/repoready.js --compact
node packages/cli/bin/repoready.js fix --dry-run

Run checks:

node --test
npm run lint
npm run web:build

Roadmap

  • CLI repository scanner
  • English and Chinese reports
  • Agent Failure Risk
  • Audit Evidence Chain
  • Fix plan and dry-run patches
  • Screenshot-friendly CLI output
  • GitHub Action wrapper
  • Optional self-hosted web report
  • Launch pack and marketing assets
  • More language-specific rules
  • More framework detection
  • Public Agent Ready Index
  • GitHub App Fix PR production flow
  • Organization dashboard

Links

License

MIT

Reviews (0)

No results found