agentleFS
zerniezernie/vigiles/src/CLAUDE.md

vigiles / src

CLAUDE.md15 starsChanged 5 months agoMITView on GitHub

Working in src/? The root CLAUDE.md holds the full positioning, architecture, and rule set — read it first. This file adds the discipline specific to the CLI surface (src/cli.ts, src/cli-main.ts, src/cli-commands.ts): keep the command set small and cohesive. A new walk over the user's repository goes through src/exclude.ts, so .vigilesrc.json#exclude applies to it; a walk that does not import it ignores what the user excluded. Guidance only — Adding a new CLI verb (or hook-runtime subcommand) is a LAST resort,…

The file

Files
CLAUDE.md
<!-- vigiles:sha256:8f6c6435dc55a17c compiled from src/CLAUDE.md.spec.ts -->

CLAUDE.md

Scope

Working in src/? The root CLAUDE.md holds the full positioning, architecture, and rule set — read it first. This file adds the discipline specific to the CLI surface (src/cli.ts, src/cli-main.ts, src/cli-commands.ts): keep the command set small and cohesive. A new walk over the user's repository goes through src/exclude.ts, so .vigilesrc.json#exclude applies to it; a walk that does not import it ignores what the user excluded.

Rules

High Bar For New Commands

Guidance only — Adding a new CLI verb (or hook-runtime subcommand) is a LAST resort, not a reflex. vigiles is ONE cohesive organism with FEW human verbs (see the cohesive-cli-surface rule in the root spec): every new command widens the surface the CLI, the GitHub Action, and the docs must all track in lockstep. A new command must clear a HIGH BAR — (1) it is a genuinely NEW mental action no existing verb owns; if it is a variant of an action a verb already does, add a FLAG to that verb instead; (2) it does NOT overlap an existing command's job — two doors to one room is the smell; (3) related siblings collapse into ONE verb with a subcommand, not N hyphenated verbs; (4) a runtime entrypoint stays hidden under hook-runtime, never a public verb. DEFAULT to extending an existing verb with a flag; spawning a sibling verb is the exception you must justify out loud. When in doubt, don't add the verb — and prefer removing or merging an overlapping one.

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.