agentleFS
ArcticFox2029ArcticFox2029/chamnan/skills/bootstrap/SKILL.md

bootstrap

Skill10 starsChanged 7 days agoMITView on GitHub

Set up chamnan in this repository for the first time — build the architecture index, measure how well the code describes itself, fill in missing file comments, and record a baseline. Run once per repo.

70 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use surprise-me, ppt-generation and 10 more.

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.
  • stophobiaSkill

    surprise-me

    Create a delightful, unexpected "wow" experience for the user by dynamically discovering and creatively combining other enabled skills. Triggers when the user says "surprise me" or any request expressing a desire for an unexpected creative showcase. Also triggers when the user is bored, wants inspiration, or asks for "something interesting".

    Also in 3 projects that use this

  • HK-hubSkill

    ppt-generation

    Use this skill when the user requests to generate, create, or make presentations (PPT/PPTX). Creates visually rich slides by generating images for each slide and composing them into a PowerPoint file.

    Also in 3 projects that use this

  • stophobiaSkill

    github-deep-research

    Conduct multi-round deep research on any GitHub Repo. Use when users request comprehensive analysis, timeline reconstruction, competitive analysis, or in-depth investigation of GitHub. Produces structured markdown reports with executive summaries, chronological timelines, metrics analysis, and Mermaid diagrams. Triggers on Github repository URL or open source projects.

    Also in 3 projects that use this

  • HK-hubSkill

    consulting-analysis

    Use this skill when the user requests to generate, create, or write professional research reports including but not limited to market analysis, consumer insights, brand analysis, financial analysis, industry research, competitive intelligence, investment due diligence, or any consulting-grade analytical report. This skill operates in two phases — (1) generating a structured analysis framework with chapter skeleton, data query requirements, and analysis logic, and (2) after data collection by other skills, producing the final consulting-grade report with structured narratives, embedded charts, and strategic insights.

    Also in 3 projects that use this

  • MicrosoftSkill

    podcast-generation

    Generate AI-powered podcast-style audio narratives using Azure OpenAI's GPT Realtime Mini model via WebSocket. Use when building text-to-speech features, audio narrative generation, podcast creation from content, or integrating with Azure OpenAI Realtime API for real audio output. Covers full-stack implementation from React frontend to Python FastAPI backend with WebSocket streaming.

    Also in 3 projects that use this

  • VercelSkill

    vercel-deploy

    Deploy applications and websites to Vercel with a claimable preview. Use when the user requests deployment actions like "deploy my app", "deploy and give me the link", "push this live", or "create a preview deployment". No authentication required - returns preview URL and claimable deployment link.

    Also in 4 projects that use this

  • +1 more from HK-hub

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 62 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do these in order. Report the numbers as you go.

    line 7
  2. Distinctive:

    Read what it printed. The important line is the described percentage.

    line 15
  3. Distinctive:

    Never edit files for this without asking first.

    line 51
  4. Very specific:

    Create .chamnan/STATE.md with what the user is actually working on right now.

    line 64

“Common” is measured: kept by at least 6 in 10 of the 62 edited versions of this file we could read. “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

Set up chamnan here

Do these in order. Report the numbers as you go; the user should see what changed, not just "done".

1. Build the index

chamnan-map

Read what it printed. The important line is the described percentage.

2. If coverage is under 70%, offer to fix it — do not just report it

First read agents from .chamnan/config.json (default true). With false the user has switched off chamnan dispatching agents of its own: report the coverage, list the files from chamnan-map --undocumented, and stop there — do not offer the commenter, do not dispatch it, and do not write the comments yourself instead. chamnan-map already honours the switch where it prints this same advice; a skill that dispatches anyway is what makes the setting mean nothing.

A low number is not a complaint about the user, it is the single biggest lever on whether any of this works. The index is built from each file's opening comment; without them it degrades to a list of filenames, which is worth little.

Say plainly what the number means and what you can do about it, then — with the user's go-ahead — dispatch the chamnan:commenter agent over the files that lack one (the plugin-scoped name, so a second installed plugin that also ships a commenter cannot be picked instead). That agent runs on a cheap model because "read this file, write one line about it" does not need an expensive one; this is the routing principle the plugin ships with, applied to its own onboarding.

Give the agent the specific file list, not the whole repo, and tell it which language to write in — read language from .chamnan/config.json (default en). The agent writes English unless you name something else, so this has to be passed explicitly.

Get that list from chamnan-map --undocumented, which prints every one of them, one path per line. The names the rebuild itself prints are capped at eight and labelled "for example" — acting on those alone fixes eight files and reports a before/after as though the gap were handled. On a repository with forty undocumented files that leaves 80% of them untouched and unmentioned.

Mention to the user that the setting exists and that changing it is one sentence: "use Thai for the comments" is enough, and you edit .chamnan/config.json for them. English costs fewer tokens on every session, but that is a default worth overriding for a team that will not read English comments — say the trade-off once and let them choose.

Then run chamnan-map again and show the before/after coverage.

Never edit files for this without asking first. It touches every undocumented file in the repo.

3. Record where things stand

chamnan-report

On a repo with history this prints a weekly trend and marks today. On a fresh one it will say there is not enough history yet — that is correct, not a failure. Say so rather than hiding it.

4. Write the first STATE.md

Create .chamnan/STATE.md with what the user is actually working on right now. Keep it short — this file is injected into every future session, so it is paid for repeatedly.

Write it at milestones only: a test suite passing, a commit landing, a decision being made, or the session ending. Not after every edit. A state file rewritten every few turns costs output tokens continuously and buries the one line that mattered in a history of near-identical versions.

5. Offer to keep it fresh

chamnan-map --install-git-hook

Offer this, do not run it unprompted — it writes into .git/hooks/, which is the user's. It appends to an existing hook rather than replacing it, and never fails a commit. Explain the reason rather than the mechanism: an index that drifts out of step with the code is worse than none, because the next session trusts it and opens the wrong file.

6. Tell the user what they got, honestly

  • how many tokens the index is versus the source it indexes
  • that the full detail is grepped, never read whole
  • that the effect compounds: this repo gets cheaper to work in the more it is revisited, and gives back nothing on a repo touched once

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.