improve README

The project's README from github.com/shadcn/improve. As one markdown file: README.md.

improve

An agent skill that audits any codebase and writes implementation plans for other agents to execute.

The idea: use your most capable model for the part where intelligence compounds — understanding the codebase, judging what's worth doing, writing the spec — and hand execution to cheaper models. The skill never implements anything itself. The plan is the product.

you          →  /improve                    (expensive model, advises)
plans/       →  001-fix-n-plus-one.md       (self-contained specs)
other agent  →  implements, tests, ships    (cheap model, executes)

Install

npx skills add shadcn/improve

Works in any agent that supports Agent Skills format. The plans it writes are plain markdown, so any agent (or human) can pick them up.

Usage

/improve                        full audit → prioritized findings → plans
/improve quick                  cheap pass: hotspots, top findings only
/improve deep                   exhaustive: every package, every category
/improve security               focused audit (also: perf, tests, bugs, ...)
/improve branch                 audit only what the current branch changes
/improve next                   feature suggestions — where to take the project
/improve plan <description>     skip the audit, spec one thing
/improve review-plan <file>     critique and tighten an existing plan
/improve execute <plan>         dispatch a cheaper executor, review its work
/improve reconcile              refresh the backlog: verify, unblock, retire
/improve ... --issues           also publish plans as GitHub issues

How to use

A typical first run, start to finish:

  1. Open your agent in the repo and run /improve (or /improve quick to keep it cheap).
  2. It maps the repo, audits it, and comes back with a findings table. Reply with the ones you want planned — "plan 1, 3 and 5".
  3. Plans land in plans/ — one file each, plus an index with the recommended order. Read them; they're meant to be reviewed.
  4. Hand a plan to any agent ("implement plans/001-*.md"), or let the skill run it: /improve execute 001. It dispatches a cheaper model in an isolated worktree, reviews the diff against the plan, and reports back with a verdict. Merging stays up to you.
  5. Next session, run /improve reconcile to clean up the backlog: verify what landed, refresh what drifted, unblock what got stuck.

Before a PR, /improve branch does the same thing scoped to just what your branch changes.

Example

A run against shadcn/ui came back with findings like:

| # | Finding                                        | Category  | Effort | Confidence |
|---|------------------------------------------------|-----------|--------|------------|
| 1 | shadow-config duplicated in search.ts/view.ts, | tech-debt | M      | HIGH       |
|   | copies already drifted (TODO at search.ts:31)  |           |        |            |
| 2 | O(n²) icon migration (migrate-icons.ts:168)    | perf      | S      | HIGH       |

…and rejected a few, with reasons recorded so they don't come back next run:

- [SEC-01] https_proxy env var "SSRF": by-design — standard proxy convention,
  every CLI honors it. Not a finding.

Picking #1 produced this plan — current code excerpted, exact steps, the repo's own test/lint commands as verification gates, and STOP conditions for when reality doesn't match.

How it works

Recon. Maps the repo: stack, conventions, and the exact build/test/lint commands — these become verification gates in every plan. It also ingests intent and design docs when present — ADRs (docs/adr/), PRDs, CONTEXT.md, DESIGN.md, PRODUCT.md — so decided tradeoffs aren't re-flagged as findings, direction suggestions stay grounded in stated product intent, and plans speak the repo's own vocabulary. Composes with any repo that already maintains these docs.

Audit. Fans out parallel subagents across nine categories: correctness, security, performance, test coverage, tech debt, dependencies & migrations, DX, docs, and direction (feature suggestions — every one must cite evidence from the repo itself, no generic idea-slop). Every finding carries file:line evidence, impact, effort, and confidence.

Vet. Subagents over-report, so the advisor re-reads every cited location itself before showing you anything — false positives get dropped, wrong attributions get corrected, rejections get recorded.

Prioritize. Findings land in a table ordered by leverage (impact ÷ effort, weighted by confidence). You pick what becomes plans.

Plan. One file per selected finding, written into plans/ with an index, priority order, and dependency graph.

What makes the plans executable

Plans are written for the weakest plausible executor — a model that has never seen the advisor session and may be much smaller. Three properties carry that:

Each plan also stamps the git commit it was written against, so executors run a mechanical drift check before touching anything.

Closing the loop

Plans aren't fire-and-forget:

Hard rules

License

MIT © shadcn

improve (shadcn/improve)

Searching Database…

9.2K ·GitHub
这是什么?它是一个智能体技能,用来审计任何代码库并编写实施计划,交给其他更便宜的模型去执行——贵的模型负责思考,便宜的模型负责打字。
这是一个独立应用,还是要加载进我的编程智能体的东西?它是一个 Agent Skill——一个纯 markdown 技能文件,可以加载进任何支持 Agent Skills 格式的智能体,不是单独安装的工具。
怎么让它在自己的仓库上跑起来?在仓库里打开你的智能体并运行 /improve(或者用 /improve quick 走一遍更便宜的流程);它会梳理并审计仓库,然后返回一张发现项清单,你从中勾选条目即可在 plans/ 里生成计划。
哪些智能体能运行这个技能?任何实现了 Agent Skills 格式的编程智能体都能加载它;由于输出是纯 markdown,任何智能体或人也可以接着使用生成的计划。
它会碰我的源代码本身吗?不会——它只写入 plans/,从不改动你的工作区;即使执行也是在一个一次性的 git worktree 里进行,最后仍需要你自己合并。
审计覆盖哪些方面?它会并行派出多个子智能体,分头覆盖九个类别:正确性、安全、性能、测试覆盖、技术债、依赖与迁移、开发者体验(DX)、文档,以及方向(必须引用仓库证据的功能建议)。
生成的计划是怎样做到让更弱的模型也能执行的?计划是自包含的,内联了代码摘录和确切的命令,带有机器可校验的验证关卡,并定义了硬性 STOP 条件,让更小的执行模型完全不需要自行发挥。
运行 /improve execute 会发生什么?它会在一个隔离的 git worktree 中启动一个更便宜的执行子智能体来实现计划,然后像技术负责人一样对照计划审查 diff,并给出批准、退回修改或阻止的结论。
审计时它会泄露我的密钥吗?不会——它从不复现密钥的具体值;发现项只记录凭据的位置和类型,并且总是会建议轮换密钥。
Creator
shadcn
Size
<0.1 MB
Stars
9.2K
Updated
CommitSep 12
Age
4mo
Commits · 90 Days