agentleFS
mayankjain1815-commitsmayankjain1815-commits/CITADEL/skills/map/SKILL.md

map

Skill4 starsChanged 4 months agoMITView on GitHub

Structural codebase index generator. Builds a compact JSON map of files, exports, imports, dependency graph, and roles. Queryable by keyword. Injected into fleet agents as context slices to reduce token usage on code navigation.

31 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use ultragoal, recover and 5 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.
  • Yeachan-HeoSkill

    ultragoal

    Create and execute durable repo-native multi-goal plans over Codex goal mode artifacts.

    Also in 3 projects that use this

  • marylinSkill

    recover

    Recover work from a crashed or interrupted session. Use when Claude crashed mid-task, after an unexpected exit, when you see 'stale sessions detected', or when you lost context and need to figure out what was happening.

    Also in 3 projects that use this

  • thoughtbotSkill

    trace

    Run a scenario and record what actually happened.

    Also in 4 projects that use this

  • POSTTTTSkill

    tidy

    Clean up and organize a project's file structure — group loose files into logical folders (images/, scripts/, styles/, etc.), remove empty directories, and delete genuinely unnecessary files. Use when the user asks to "clean up the project", "organize the files", "tidy the directory", "sort these into folders", "remove empty folders", or "get rid of junk files". Always understands the project and updates references BEFORE moving anything, never deletes load-bearing files, and gets approval before changing the file tree.

    Also in 3 projects that use this

  • bradtraversySkill

    feature

    Manage current feature workflow - start, review, explain or complete

    Also in 4 projects that use this

  • LangChainSkill

    remember

    Review the current conversation and capture valuable knowledge — best practices, coding conventions, architecture decisions, workflows, and user feedback — into persistent memory (AGENTS.md) or reusable skills. Use when the user says: (1) remember this, (2) save what we learned, (3) update memory, (4) capture learnings.

    Also in 4 projects that use this

The file

We split this skill into the rules it gives an agent

12 rules. 0 are common, 8 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 21 edited versions we read keep these.

  • 8

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

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

    Do not use /map for:

    line 31
  2. Distinctive:

    Run the index generator:

    line 51
  3. Very specific:

    Add --force if the user requested a fresh rebuild or if the index is stale.

    line 57
  4. Very specific:

    If .planning/map/ does not exist, the generator creates it automatically.

    line 73
  5. Distinctive:

    When another skill or orchestrator needs a map slice for agent injection:

    line 102
  6. Distinctive:

    Before injecting an existing map into a long-running campaign, run:

    line 125
  7. Very specific:

    Before spawning each wave, Fleet checks if .planning/map/index.json exists

    line 142
  8. Distinctive:

    If it exists: Fleet runs a slice scoped to each agent's assigned domain

    line 143
  9. Distinctive:

    If the index does not exist: Fleet proceeds without a map slice (no error)

    line 146
  10. Distinctive:

    Windows paths: All stored paths use forward slashes for cross-platform consistency.

    line 180
  11. Distinctive:

    After stats: print the full statistics block.

    line 199
  12. Distinctive:

    After slice: output the formatted slice block ready for injection.

    line 201

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

/map -- Codebase Intelligence

Orientation

Use /map when:

  • Starting work on an unfamiliar codebase (build the index first)
  • A fleet or archon campaign needs agents to know "what files matter for X"
  • You want a quick structural overview (stats, roles, dependency graph)
  • You need to find files related to a keyword without exploratory reads

Do not use /map for:

  • Reading file contents (use Read)
  • Searching for string patterns inside files (use Grep)
  • Single-file edits where you already know the path

Commands

CommandBehavior
/mapGenerate or refresh the index (skips if cache is fresh)
/map --forceRebuild the index even if cache is fresh
/map query <terms>Search the index for files matching keywords
/map statsPrint summary statistics (files, lines, languages, roles)
/map slice <terms>Output a compact context slice for agent injection
/map staleDetect added, changed, or removed indexed source files

Protocol

Step 1: GENERATE INDEX

Run the index generator:

node scripts/map-index.js --generate --root .

Add --force if the user requested a fresh rebuild or if the index is stale.

The generator:

  1. Walks the project tree (respects .gitignore, skips node_modules, dist, etc.)
  2. Extracts exports, imports, and symbols from each source file
  3. Infers a role for each file (component, hook, store, route, test, config, etc.)
  4. Builds a dependency graph from resolved import paths
  5. Records per-file SHA-256 hashes plus a whole-index source signature
  6. Extracts route-like paths and package verification scripts
  7. Writes the index to .planning/map/index.json

Supported languages: TypeScript, JavaScript, Python, Go, Rust.

Cache behavior: The index is cached for 5 minutes. Subsequent runs within that window exit immediately unless --force is passed.

If .planning/map/ does not exist, the generator creates it automatically.

Step 2: QUERY (when user provides search terms)

node scripts/map-index.js --query "<terms>"

The query engine scores files by:

  • Path match: +3 per term
  • Export match: +5 per term
  • Symbol match: +2 per term
  • Role match: +1 per term

Results are sorted by score and capped at 20 files (configurable with --max-files). Output is budget-capped at 8000 characters to stay injection-safe.

Step 3: STATS (structural overview)

node scripts/map-index.js --stats

Outputs: file count, line count, export count, dependency edge count, route count, package script count, verification command count, breakdown by language, and breakdown by role.

Step 4: SLICE (agent context injection)

When another skill or orchestrator needs a map slice for agent injection:

  1. Run node scripts/map-index.js --slice "<scope terms>" --max-files 15
  2. Inject the generated compact block:
=== MAP SLICE: <terms> ===
Generated: <timestamp>
Verification: npm run test | npm run typecheck
<score> <role>  <path>  [<top exports>]  (<lines>L)
...
=== END MAP SLICE ===
  1. The calling skill injects this block into the agent's prompt alongside CLAUDE.md and rules-summary.md

Token budget: A 15-file slice is typically 800-1200 tokens. This replaces 2000-5000 tokens of exploratory Glob/Grep results that agents would otherwise spend finding relevant files.

Step 5: STALENESS CHECK

Before injecting an existing map into a long-running campaign, run:

node scripts/map-index.js --stale

The command exits 0 when the map is current and 2 when indexed source files were added, changed, or removed. Refresh with:

node scripts/map-index.js --generate --force --root .

Fleet Integration

Fleet agents receive map slices automatically when /map index exists:

  1. Before spawning each wave, Fleet checks if .planning/map/index.json exists
  2. If it exists: Fleet runs a slice scoped to each agent's assigned domain
  3. The generated slice is prepended to the agent's context alongside CLAUDE.md and rules-summary.md
  4. If the index does not exist: Fleet proceeds without a map slice (no error)

Context injection order:

  1. CLAUDE.md content
  2. .claude/agent-context/rules-summary.md
  3. Map slice (scoped to agent's domain/direction)
  4. Campaign-specific direction and scope
  5. Discovery briefs from previous waves

Contextual Gates

Disclosure: "Generating codebase map. Creates .planning/map/index.json." Reversibility: green — creates .planning/map/index.json only; undo by deleting .planning/map/. Trust gates:

  • Any: generate index, query, stats, slice.

Quality Gates

  • Index must generate without errors on any supported project
  • Query must return results sorted by relevance score
  • Stats output must be human-scannable in under 5 seconds
  • Slice output must stay under 2000 tokens for a 15-file result
  • Index must handle 100K+ line repos without hanging (iterative walker, no recursion limits)
  • Cache must prevent redundant regeneration within the TTL window
  • Stale checks must detect added, changed, and removed indexed source files
  • Slice output must include relevant verification commands when package scripts exist

Fringe Cases

  • No source files found: Generator writes an empty index (fileCount: 0). Query returns no results. Not an error.
  • .planning/ does not exist: Generator creates .planning/map/ automatically via mkdirSync({ recursive: true }).
  • Index file missing when querying: Error message: "Index not found. Run node scripts/map-index.js --generate first."
  • Binary or unsupported files: Silently skipped. Only files with recognized language extensions are indexed.
  • Very large repos (10K+ files): The walker is iterative (stack-based), not recursive. No stack overflow risk. May take 5-10 seconds on first run.
  • Windows paths: All stored paths use forward slashes for cross-platform consistency.

Exit Protocol

After generation:

Index written: <path>
  <file count> files, <edge count> dependency links
  <route count> routes, <verification command count> verification commands

After query:

Results for "<terms>" (<count> matches):
  Score  Role        Path
  -----------------------------------------------
  <results>

After stats: print the full statistics block.

After slice: output the formatted slice block ready for injection.

After stale check:

Map index is current.

or:

Map index is stale.
Changed: <paths>
Added: <paths>
Removed: <paths>

Reversibility: green — delete .planning/map/ to remove all generated artifacts; no source files modified.

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.