readme-sync

readme-sync is a skill for Claude Code, Codex from scroogy-dev/scroogy-agent-skills. It costs 71 tokens per session (3,559 once invoked), scanned A, original, Apache-2.0.

A workflow for creating or updating a project's README.md, the main introductory document that explains a codebase to people. It analyzes the project and supports separate setup and refresh modes.

In plain words
What is it for?
Use it to initialize a README for a new project or refresh an existing README after the project changes, with optional individual or business defaults.
Why use it?
It keeps basic project documentation aligned with the current file structure while preserving user-written content during updates. It also avoids assuming whether a missing or existing README needs the other mode.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/scroogy-dev/scroogy-agent-skills/readme-sync
Any agent
npx skills add scroogy-dev/scroogy-agent-skills --skill readme-sync
Clone the repo
git clone --depth 1 https://github.com/scroogy-dev/scroogy-agent-skills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-sync

README.md
[![agentmods](https://agentmods.dev/badge/skills/scroogy-dev/scroogy-agent-skills/readme-sync.svg)](https://agentmods.dev/skills/scroogy-dev/scroogy-agent-skills/readme-sync)
Your own site
<a href="https://agentmods.dev/skills/scroogy-dev/scroogy-agent-skills/readme-sync"><img src="https://agentmods.dev/badge/skills/scroogy-dev/scroogy-agent-skills/readme-sync.svg" alt="Measured on agentmods" height="20"></a>
Per session 71 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,559 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00071 $0.03559
Opus 5 $0.00036 $0.01780
Sonnet 5 $0.00014 $0.00712
Haiku 4.5 $0.00007 $0.00356

Measured 6d ago against content hash 559e91a29580, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

readme-sync scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

readme-sync/SKILL.md · 221 lines

How it starts

The opening of the file, as written. The whole thing — 221 lines — stays where its author put it; the contents beside it link to each section on GitHub.

개요

사람을 위한 README.md를 두 모드로 다룹니다.

  • init: README가 없을 때 템플릿 기반으로 새로 작성합니다.
  • update: README가 이미 있을 때 프로젝트 재분석 결과로 갱신합니다. 사용자 작성 콘텐츠는 보존합니다.

설계 원칙

  • Simple is Best. 꼭 필요한 섹션만 두고, 각 섹션은 짧게 씁니다. 길면 사람들이 읽지 않습니다.
  • 모드와 프로파일은 직교. --profileinit의 기본값 프리셋이고 update에서는 무시합니다. "프로파일 때문에 기존 README가 망가졌다" 경로를 차단합니다.
  • 말미 블록(라이선스·개인 저작물 고지)은 항상 옵션. 둘 다 비우는 것도 정상 경로입니다.

사용법

/readme-sync [--mode=init|update] [--profile=individual|business] [--force-license]

인자

인자 역할
--mode init / update 동작 모드. 미지정 시 README.md 존재 여부로 추정.
--profile individual / business init 모드의 라이선스·고지 기본값 프리셋. update에서는 무시.
--force-license (플래그) 기존 LICENSE 파일 덮어쓰기 허용. init 모드 + Q1=(a) 전용, 가드 통과 시에만 동작. 자세한 사양은 references/license.md 참고.

모드 선택 규칙

  1. 인자가 명시되면 그대로 사용합니다.
  2. 미지정이면 README.md 존재 여부로 추정합니다 (없으면 init, 있으면 update).
  3. 추정과 사용자 의도가 어긋날 가능성이 있으면 1회 확인합니다.

프로파일 기본값 프리셋

프로파일 라이선스 표시 기본값 개인 저작물 고지 기본값
individual 사용자에게 (a)/(b) 중 선택을 요청 포함
business (c) 표시하지 않음 미포함
(미지정) 두 질문을 그대로 제시 두 질문을 그대로 제시

프로파일은 기본값 프리셋일 뿐이며, 사용자는 개별 질문에서 다른 값을 자유롭게 선택할 수 있습니다.


init 모드

init-1단계: 프로젝트 분석

다음 정보를 수집합니다.

  • 디렉토리 구조 (최대 깊이 2; 디렉토리 트리 정렬 규칙 적용)
  • 프로젝트 성격 단서: package.json, pyproject.toml, Cargo.toml, .ai/AI-CONTEXT.md
  • LICENSE 파일 존재 여부
  • LICENSE-* 하이픈 패턴 비표준 파일 존재 여부 (헤더 파일 등; 발견 시 references/license.md의 "라이선스 헤더 파일명 가드" 참고)
  • git config user.name, git config user.email로 Copyright 후보 추출

init-2단계: 대화형 질문

Q1. 라이선스 표시

README 말미에 라이선스 표시를 둘까요? (개인 작업이면 일반적으로 둡니다)
  (a) 오픈소스 라이선스 — Apache 2.0 / MIT 등. LICENSE 파일과 연결합니다.
  (b) 개인 저작물·비공개 표기 — 권장: All Rights Reserved
  (c) 표시하지 않음 — 회사 업무에서 흔한 선택입니다.
  • --profile 기본값이 있으면 그 값을 하이라이트하고 확인만 받습니다.
  • LICENSE 파일이 이미 있으면 (a)를 기본값으로 제시하고 라이선스 종류는 파일에서 자동 추정합니다.

Read the full file on GitHub · 221 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 221 lines · 71 tokens per session scan A 559e91a29580

Subscribe to this mod's changes

readme-sync is a skill published in the GitHub repository scroogy-dev/scroogy-agent-skills (2 stars, last pushed 5d ago), licensed Apache-2.0. It adds 71 tokens to every session and 3,559 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens