Skip to content

Guide · Agent skill

How to use the Compound Refresh agent skill

Updated · written with AI from the project's own documentation and checked against our catalogue data

Compound Refresh is an agent skill that reviews the team's saved learning documents, the notes on past fixes and decisions kept under a solutions folder in your repo, and checks each one against the current code. It is for teams that keep a documented knowledge base in a repository and want it to stay accurate. After this guide you will know what the skill does, how to install it, how to ask for a run in plain language, and what to check before you rely on its changes.

Compound RefreshEveryInc/compound-engineering-plugin · MIT

Quick start

  1. 1Download the ZIP. Get the ZIP for skills/ce-compound-refresh from the page where you found this guide.
  2. 2Unzip into a skills folder. Place the contents in ~/.claude/skills/ for personal use, or in .claude/skills/ inside a project.
  3. 3Or upload in the Claude apps. In the Claude apps, go to Settings → Capabilities → Skills and upload the skill.
  4. 4Check the repo. Make sure the repo has git, Python 3, and a solutions folder of learning documents under <root>/solutions/.
  5. 5Ask for an audit. Make a plain request such as auditing stale or overlapping learnings, with an optional scope hint.
  6. 6Review the report and commit. Read the Applied and Recommended sections, then review the commit or pull request before relying on the changes.

What the skill makes the agent do

Once installed, the agent audits the learning documents under <root>/solutions/ against the current codebase. It flags documents that are stale, duplicated, superseded, or contradictory. It then applies the maintenance action the evidence supports: update, merge, replace, or delete. For each document it prints a per-document report, and it commits the changes it made.

The skill is designed not to change product code. If a learning conflicts with a skill, runbook, or instruction file, the skill reports the conflict and does not edit that file.

  • Keep: still accurate and useful, no edit.
  • Update: the fix still holds but paths, names, links, or snippets have drifted.
  • Consolidate: two overlapping docs are both correct, so unique content is merged into one and the other is deleted.
  • Replace: the guidance is misleading and a trustworthy successor can be written.
  • Delete: the document is no longer useful, applicable, or distinct.

Check the requirements before installing

The skill needs git, because it uses git rev-parse and commits its changes. It also needs Python 3 to run scripts/validate-doc-claims.py. The repo should have a solutions folder of learning documents, since there is nothing to audit without one.

The repo may have a .compound-engineering/config.yaml file that optionally sets docs_root. If docs_root is not set, the artifact root is docs. If it is set, it must be a repo-relative directory that stays inside the repo; otherwise the skill stops with an error naming docs_root.

  • git available in the repo
  • Python 3 available to run scripts/validate-doc-claims.py
  • A solutions folder of learning documents, under <root>/solutions/
  • Optional: .compound-engineering/config.yaml with docs_root

Install the skill

Download the ZIP for skills/ce-compound-refresh from the page where you found this guide. Unzip it into one of two places. For all your projects, use ~/.claude/skills/. For one project only, use the .claude/skills/ folder inside that project.

If you use the Claude apps instead, upload the skill under Settings → Capabilities → Skills.

  • Personal install: unzip into ~/.claude/skills/
  • Project install: unzip into .claude/skills/ inside the project
  • Claude apps: Settings → Capabilities → Skills, then upload

Trigger the skill with a natural request

The skill is meant to be triggered when you want to audit stale, overlapping, superseded, or drifted learnings. Ask in plain language that names the learnings and the kind of check you want. You can add an optional scope hint, such as a directory, filename, module, or keyword, to narrow the run. A hint that matches nothing does not widen the scope.

Say so if you want the run to be unattended. The argument hint includes an optional mode:non-interactive flag. Interactive mode asks you questions when a decision needs your input.

If you ask to clean up, cull, prune, or trim the learnings, the skill reads that as a request to delete or shorten docs. Before it investigates, it states that reading back and asks you to choose. Option 1 deletes or shortens docs the codebase already explains, with each cut quoting the test, code comment, or instructions file that supports it. Option 2 fixes drift only and deletes nothing accurate.

  • Audit the learnings under the auth module for stale or duplicate docs.
  • Check the solutions folder for learnings that contradict current code.
  • Refresh the learnings that mention the billing module, and commit the changes.
  • Clean up the learnings in the payments folder (the skill will ask which option you want).
[optional: scope hint — directory, filename, module, or keyword] [mode:non-interactive]

Read the report and review the commit

The report is the main deliverable. It is printed as markdown, split into Applied and Recommended items. Recommended covers things the skill did not apply on its own, including failed writes. In non-interactive mode the report is the only output, so read it carefully.

On the repo's default branch, non-interactive runs create a branch named for what was refreshed, commit there, and attempt a pull request. If PR creation fails, the report gives the branch name. On a feature branch, the changes are a separate commit on that branch. If git fails, the report includes the commands to run. Review the committed changes before you rely on them, because a cleanup pass can delete documents.

Safety notes: scripts and network

The skill runs scripts. Specifically, it runs scripts/validate-doc-claims.py, which requires Python 3. The skill does not use the network. The source does not describe what the script checks beyond its role in validating doc claims, so read the script before running the skill in a sensitive repo.

The skill can delete documents, and it commits changes through git. Keep the changes on a branch you can review, and check the diff before merging.

  • Runs scripts: yes (scripts/validate-doc-claims.py, Python 3)
  • Uses network: no
  • Can delete learning documents; review the commit before relying on it
  • Designed not to change product code or edit skill, runbook, or instruction files

Tips for good results

Give a specific scope. A module name or folder gives a more focused audit than a whole-store run.

Use the report's Recommended list as a to-do list. Items there were not applied automatically.

Keep learnings in the solutions folder. Documents outside the scope are not checked.

The skill does not check code for general refactoring, debugging, or code review. Use it for the learnings store, not as a general code reviewer.

What people use it for

  • Finding learnings in a module that no longer match the current code paths.
  • Merging two overlapping docs about the same fix into one canonical document.
  • Marking or replacing guidance that the codebase has superseded.
  • Auditing a store of internal notes before the team relies on them for a decision.

Frequently asked questions

How do I install the Compound Refresh skill?

Download the ZIP for skills/ce-compound-refresh and unzip it into ~/.claude/skills/ for personal use or into .claude/skills/ inside a project. In the Claude apps, you can instead upload it under Settings → Capabilities → Skills.

What does the Compound Refresh skill require?

It requires git, since it uses git rev-parse and commits its changes, and Python 3 to run scripts/validate-doc-claims.py. The repo needs a solutions folder of learning documents, and it can optionally use a .compound-engineering/config.yaml that sets docs_root.

Is the Compound Refresh skill free to use?

The skill is published under the MIT licence. The source does not state any price, so check the licence text on the project page for the terms.

Will the skill change my product code?

No. The skill is designed not to change product code. It updates, merges, replaces, or deletes learning documents, and it does not edit skill, runbook, or instruction files when a learning conflicts with them.

What if my repo has no learnings folder?

The skill is for repos with a solutions folder of learning documents. Without one there is nothing to audit. If docs_root is set to an invalid value, the skill stops with an error naming docs_root.

How is this different from a general code review or refactoring tool?

The skill is for auditing a repo's saved learnings against the current code. Its description says to avoid general refactoring, debugging, or code review unless the learnings store is the explicit target. The source does not compare it with other tools.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use Compound Refresh if your team keeps a solutions folder of past fixes and decisions and wants it checked against the current code on a regular basis. Pick something else if your repo has no learning documents, or if you need general refactoring, debugging, or code review, since the skill is scoped to the learnings store.

Download the skill