agentleFS
Sign inStart free
joevilcai666joevilcai666/how-it-works-skill/skills/how-it-works-setup/SKILL.md

how-it-works-setup

Skill1 starsChanged 31 days agoMITView on GitHub

Install project-local HOW_IT_WORKS.md maintenance instructions. Use when someone asks to set up this skill, install its document maintenance rules, or prepare a project for its first HOW_IT_WORKS.md.

  • In this repositoryOne other file it gives its agents.

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use zh-CN for Chinese and en for English.

    line 12
  2. Very specific:

    When the user asks to create or refresh the document, invoke $how-it-works.

    line 28
  3. Distinctive:

    Read the main skill before that work.

    line 29

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

How It Works Setup

  1. Choose en or zh-CN from the user's language. Use zh-CN for Chinese and en for English. For other languages, use en for the instruction block.

  2. Resolve the project root and the installed how-it-works skill directory. Run its updater:

    python3 "<how-it-works-directory>/scripts/update_project_instructions.py" --project-root "<project-root>" --language en

    Replace the path values and language before execution. On failure, report the exact error. Do not bypass the updater's checks.

  3. Report the modified files from the updater's result. Distinguish created, updated, unchanged, and absent files.
  4. When the user asks to create or refresh the document, invoke $how-it-works. Read the main skill before that work. The main skill owns all investigation, evidence, and output rules.

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.

Check your setup, free