agentleFS
brquattibrquatti/readme-style/skills/config/SKILL.md

config

Skill0 starsChanged 2 months agoMITView on GitHub

Show or change this project's readme-style settings (`lang`, `sections`, `hook`) in `.readme-style.json` at the repo root. Use when the user asks to configure readme-style, set the README language, choose which sections it writes, or turn the startup note off.

26 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use uninstall and resume.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • AnthropicSkill

    uninstall

    Uninstall a community skill that was installed via the hub. Confirms before deleting files, refuses to touch first-party plugin skills, and logs every action. Use when the user wants to fully remove a community skill ("uninstall [skill]", "remove this skill") rather than just disable it.

    Also in 3 projects that use this

  • genomewalkerSkill

    resume

    Resume a thread by loading its ~800-token context capsule

    Also in 3 projects that use this

The file

Files
SKILL.md

Show or change the readme-style settings

!node "${CLAUDE_PLUGIN_ROOT}/hooks/scripts/check-readme.mjs" --config "$ARGUMENTS"

Relay the output above in two or three lines: which file it points at, the settings it lists, and — when a key was set — what changed. On an error line, say what was rejected and name the valid keys (lang, sections, hook).

Nothing else to do: the script already wrote the file. Do not read, write, or modify any file yourself. Mention /readme-style:apply only when the user asks to regenerate the README with the new settings.

What each key does

  • lang — language code (en, pt, pt-BR) that apply writes the README in. Unset: English, regardless of the language the existing README is in.
  • sections — the ## <emoji> Section headings apply writes, in order, comma or | separated. Unset: the default set for the language.
  • hook — off silences the SessionStart note in this project. README_STYLE_HOOK=0 silences it everywhere.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.