agentleFS
celestialdustcelestialdust/achilles-skills/skills/project-setup/SKILL.md

project-setup

Skill1 starsChanged 2 months agoMITView on GitHub

Scaffold the repo substrate the suite reads cold: the STATE.md board, CONTEXT.md, the ADR and per-feature homes, the session snapshot, the append-only log and lessons record, and the `## Agent skills` block. Run it once per repo before the first feature, or to repair a missing one. Not the per-run environment gate — preflight-readiness owns that.

48 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use creative-writing-craft, creative-writing-muse and 9 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.
  • Abdullokh-NSkill

    creative-writing-craft

    Справочник ремесла: проза, сцена, стиль, голос. Загружать, когда нужно знание "как писать", а не режим производства.

    Also in 3 projects that use this

  • Abdullokh-NSkill

    creative-writing-muse

    Точка входа в набор скилов для длинной прозы. Включается, когда автор просит спланировать, написать, продолжить, переписать или разобрать художественный текст — роман, повесть, цикл рассказов. Ведёт маршрут от замысла к готовому куску и держит базу знаний проекта.

    Also in 3 projects that use this

  • badgidsSkill

    character-sim

    Pressure-test a character by speaking or reasoning strictly from that character's current voice, goals, relationships, emotional pressure, and knowledge boundary without creating canon by accident.

    Also in 3 projects that use this

  • jpsweeney97Skill

    writing-principles

    Enforces writing principles for instruction documents (SKILL.md, skill supporting files, subagents, CLAUDE.md). Use when writing, reviewing, or editing any file in **/skills/**/*.md, **/agents/*.md, or **/CLAUDE.md. Triggers on skill creation, skill file updates, CLAUDE.md changes, subagent authoring, or instruction document review.

    Also in 3 projects that use this

  • ItsSidharthaSkill

    story-planning

    Collaborative planning skill for a GitHub issue. Takes issue content and codebase context as input. Runs an iterative clarification loop until the user explicitly agrees to a plan, then saves it to docs/<story_number>/plan.md. Used by the user-story-implementation skill — load this skill at the start of Phase 1 and follow it completely before returning to the orchestrator.

    Also in 3 projects that use this

  • badgidsSkill

    story-review

    Diagnose existing prose at a chosen editorial level, from whole-story and developmental problems through scene, line, copy, and proof passes, without rewriting until the diagnosis is accepted.

    Also in 3 projects that use this

  • +4 more from Abdullokh-N

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 40 edited versions we read keep these.

  • 1

    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. Very specific:

    Skip: when STATE.md is there and the substrate is intact.

    line 22
  2. Distinctive:

    Read as they are; nothing upstream feeds this.

    line 29

“Common” is measured: kept by at least 6 in 10 of the 40 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

Project setup

Purpose

Stage: cross-cutting. Principles 5, 6, 9.

The one-time bootstrap. It writes what every other skill reads cold — the board, the glossary, the ADR and per-feature homes, the three session records — plus the ## Agent skills block in one rules file and a pointer in the other. Without it each skill re-derives where the board is and where a decision gets written down, and the answers disagree.

When to use / when to skip

  • Use once per repository, before the first feature — ahead of any Ideate, Spec or Plan work.
  • Re-run to repair a missing substrate file, or a pointer naming a file no longer there — nothing watches for either between runs.
  • Skip when STATE.md is there and the substrate is intact. Not per feature — plan-breakdown appends feature blocks to a board that already exists.
  • Not the per-run environment gate that re-fires every wave; preflight-readiness owns that.
  • Not the glossary or the ADRs themselves — spec-grilling fills what this run leaves empty.

Inputs

Read as they are; nothing upstream feeds this.

  • CLAUDE.md / AGENTS.md — helps: says which already holds the rules · without it: ask the person, or with nobody there create CLAUDE.md and mark it derived.
  • The seven under Outputs — helps: says what to adopt · without it: create that one.
  • .gitignore — helps: says whether a record would be ignored · without it: nothing is ignored.
  • git remote -v — helps: names the project in the seeds · without it: the directory name, derived.

Process

  1. Read the repo before writing to it — both rules filenames, the seven, .gitignore, git remote -v. The tracker is always the local STATE.md board; where issues live is never asked.
  2. Ask at most two questions, and only with a person there — which file holds the rules when neither exists, and whether the pointer may go into the other when it already carries content. One at a time, each with a one-line explainer. With nobody there create CLAUDE.md, add the pointer, mark both derived.
  3. Adopt every file that already exists, in place — repair what is missing, clobber nothing: a docs/session-log.md or docs/lessons.md entry exists nowhere else.
  4. Write the seven, skipping any that exist, from references/seeds.md — the two directories each with a .gitkeep. Seed no entry and fill no field: these are structure, not config, so no value, no shell command, and never a credential's value (safety-rails.md).
  5. Put the ## Agent skills block from references/seeds.md in exactly one file — CLAUDE.md if it exists, else AGENTS.md, else the choice from step 2. Update a block already there in place rather than appending a second; leave its neighbours alone. Check the seed's file list against what step 4 wrote, not against memory.
  6. Seed a fresh CLAUDE.md from assets/CLAUDE.template.md, block beneath. Only for a CLAUDE.md this run creates — never into an AGENTS.md, never over an existing one.
  7. Write the pointer from references/seeds.md into the other filename, its first sentence verbatim — the check below reads that line to find the file it names. If the person declines it, say what that leaves: a tool opening a file that routes nowhere.
  8. Surface a .gitignore pattern matching any record rather than editing that file yourself.
  9. Report what landed — which file holds the rules, which is the pointer, what each record is for and who writes it. Name what is theirs to hand-edit: STATE.md, CONTEXT.md, the five snapshot fields; never a log or lessons entry.

Rationalizations

  • "Issues already live on GitHub." → STATE.md is the only work surface here; nothing else has a gate.
  • "The glossary can wait for terms." → the Spec sitting has nowhere to append if it is absent.
  • "The pointer file may as well repeat the important rules." → that is the second copy, and a reader cannot tell which is stale.
  • "This log is messy; a clean re-scaffold helps." → its entries exist nowhere else, and a tidy file that lost them proves nothing.
  • "One seeded entry makes the shape obvious." → the shape is in the fenced block; a seeded entry claims work happened here.
  • "These are run scratch files." → an ignored record dies on the next fresh clone, its one real reader.

Red flags

  • The ## Agent skills block in both rules files, or a second copy beside one already there.
  • A pointer naming a file that is not there, or reworded away from the seed's first sentence.
  • A seeded entry in the log or the lessons record, or a filled field in the snapshot.
  • STATE.md scaffolded with feature blocks or slice rows, or its cells holding sentences.
  • The behavioural template written into an AGENTS.md, or over a CLAUDE.md that already existed.
  • A record added to .gitignore, or a .gitignore match quietly edited away here.

Verification

  • The seven exist and this run created no eighth — no docs/progress.md, docs/design.md, CONTEXT-MAP.md.
  • One rules file carries the block, naming all seven and sending a fresh agent to the snapshot before work, the log before re-opening a question, the lessons before a skeleton. The other holds the pointer alone.
  • docs/lessons.md carries one ## Entry shape heading outside any fence, the seven-field template in the first fenced block beneath it.
  • Nothing this run created carries content — the counts below run only over a record this run created.
for f in STATE.md CONTEXT.md docs/session-state.md docs/session-log.md docs/lessons.md; do
  [ -s "$f" ] || echo "missing or empty: $f"          # -s: a missing file reports on stderr
  git check-ignore -q "$f" && echo "ignored by .gitignore: $f"
done
for d in docs/adr docs/features; do [ -f "$d/.gitkeep" ] || echo "missing: $d/.gitkeep"; done
grep -c '^## Glossary$' CONTEXT.md                                                       # 1
awk '/^## Log$/{print "pre-split ## Log — handoff migrates its entries"}
     /^## /{h++;next} h&&NF{print "filled: "FNR} END{print h+0}' docs/session-state.md   # 5, nothing else
awk '/<!--/{c=1} c{if(/-->/)c=0;next} /^### /{n++} END{print n+0}' docs/session-log.md    # 0
awk '/^```/{f=!f;next} !f&&/^## /{n++} END{print n+0}' docs/lessons.md                    # 1
for f in CLAUDE.md AGENTS.md; do
  [ -f "$f" ] || { echo "missing: $f"; continue; }
  n=$(sed -n 's/^The rules for this repository live in `\(.*\)`\..*/\1/p' "$f")
  [ -z "$n" ] || [ -f "$n" ] || echo "broken pointer: $f names $n"
done
  • Each ran once against a scratch copy that should fail it — an entry pasted into the log, a filled snapshot field, the pointer's target renamed, a zero-length CONTEXT.md — and reported. A check nobody has watched fail reads like one that cannot.
  • A .gitignore match, or a ## Log heading in an adopted snapshot, was reported rather than fixed here — handoff migrates such entries into the log verbatim.

Outputs & handoff

Five seeded files from references/seeds.md and two directories, each skipped if it exists. Shape, tokens and writers for the four state files are stated once in state-schema.md. Report what you wrote against its cap; nothing over-cap is handed on as if it fit. No verdict — the scaffold is reported in conversation.

  • STATE.md · the title and three legend lines, no feature block.
  • CONTEXT.md · 1,000 words — one ## Glossary, no terms, the comment stating the entry shape.
  • docs/adr/ · 350 words per record — the ADR home, ADR-<NNN>-<slug>.md, plus .gitkeep.
  • docs/features/ · cap per its writer — the root docs/features/<slug>/, plus .gitkeep.
  • docs/session-state.md · 300 words — the five headings, blank.
  • docs/session-log.md · 60 words per entry — the preamble and the entry shape in an HTML comment, no entry.
  • docs/lessons.md · 80 words per entry — ## Entry shape, the seven-field template fenced beneath it, no entry.

Plus the ## Agent skills block in one rules file and the pointer in the other, both from references/seeds.md — a block inside an existing file, never an eighth scaffolded one. A fresh CLAUDE.md leads with assets/CLAUDE.template.md.

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.