readme-agents

A documentation-maintenance skill that keeps AGENTS.md, instructions for coding agents, and README.md, instructions for human users, aligned with a repository.

In plain words
What is it for?
It is for scanning project files, updating both documents, separating agent guidance from user instructions, and checking their links.
Why use it?
It removes the problem of documentation becoming outdated as the project's tools, layout, setup, and usage change.

Skill for Claude CodeCodex

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/fmind/dotfiles/readme-agents
Any agent
npx skills add fmind/dotfiles --skill readme-agents
Clone the repo
git clone --depth 1 https://github.com/fmind/dotfiles

Made for: Claude Code, Codex.

Per session 44 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 411 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 $0.00044 $0.00411
Opus 5 $0.00022 $0.00205
Sonnet 5 $0.00009 $0.00082
Haiku 4.5 $0.00004 $0.00041

Measured 2d ago against content hash 605fe9191a7f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

readme-agents 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 2d 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.

skills/readme-agents/SKILL.md · 40 lines

What it actually says

Sync README and AGENTS Files

Refresh AGENTS.md and README.md to accurately reflect the repository's state.

Scope

  • AGENTS.md (For AI): Tooling, commands, technical conventions, and repository layout.
  • README.md (For Humans): Project purpose, installation, setup, and usage.

Workflow

  1. Research: Scan the root directory and key config files (e.g., pyproject.toml, go.mod, mise.toml, lefthook.yml) to identify tools and structure.
  2. Update AGENTS.md:
    • Refresh tool list and commands.
    • Update the Layout section (a bullet list of top-level files/dirs with a one-sentence purpose each).
  3. Update README.md:
    • Ensure purpose, prerequisites, and usage examples are current.
    • Remove stale instructions.
  4. Validate: run lychee README.md AGENTS.md so refreshed links are proven live, not assumed.

Gotchas

  • Separation of Concerns: Do not mix user-facing installation instructions (for README.md) with technical conventions and rules (for AGENTS.md).
  • No-Hard-Wrap: Keep each paragraph on a single line in both files.

Documentation

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. 2d ago First seen · 40 lines · 44 tokens per session scan A 605fe9191a7f

Subscribe to this mod's changes

readme-agents is a skill published in the GitHub repository fmind/dotfiles (4 stars, last pushed 2d ago), licensed MIT. It adds 44 tokens to every session and 411 once invoked, about $0.0002 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

dotfiles-bootstrap

Bootstrap a workstation with the dotfiles framework. Takes a GitHub user / owner+repo / explicit clone URL and runs dot init (which shells out to chezmoi) with the right safety prompts. Honors the active agent profile (ask / plan / apply / audit) so it defaults to dry-run in safer modes and full apply in apply.

sebastienrousseau/dotfiles · 88 tokens

vibe

Delegate a coding task to a cheap AI model (Mistral Vibe by default, but any provider Vibe knows about — DeepSeek, Gemini Flash, etc.) and supervise the result via git diff. Claude orchestrates, the cheap model codes. Claude consumes 500-1500 tokens per delegation regardless of how many file reads the delegate does…

sebastienrousseau/dotfiles · 137 tokens

aiq-research

Use when asked to run deep research or AI-Q research through a reachable NVIDIA AI-Q Blueprint backend.

laurigates/dotfiles · 25 tokens

obsidian-bases

Obsidian Bases database feature for YAML-based interactive note views. Use when creating .base files, writing filter queries, building formulas, configuring table/card views, or working with Obsidian properties and frontmatter databases.

laurigates/dotfiles · 49 tokens

telegram

Send notifications, interactive questions, or multiple-choice polls to the user via Telegram. Use when the user asks to be notified ("ping me", "notify me on Telegram", "ask me when..."), when a long-running task finishes and the user is likely away, when an irreversible action needs out-of-band confirmation, or when…

laurigates/dotfiles · 117 tokens

chezmoi-expert

Comprehensive chezmoi dotfiles management expertise including templates, cross-platform configuration, file naming conventions, and troubleshooting. Covers source directory management, reproducible environment setup, and chezmoi templating with Go templates. Use when user mentions chezmoi, dotfiles, cross-platform…

laurigates/dotfiles · 88 tokens