codemap
/codemap
Śledzi jeden przepływ w kodzie i zapisuje go jako mapę markdown z diagramem Mermaid oraz odnośnikami do plików.
- Autor
- capgoblin ↗
- Repozytorium
- codemap ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 21.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 7
- Skrypty
- 1
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 21.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
- 1 skrypt w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
Skrypty: scripts/cite.py
Co robi i kiedy
Śledzi jeden przepływ w kodzie i zapisuje go jako mapę markdown z diagramem Mermaid oraz odnośnikami do plików.
Wyzwalacze z opisu
Oryginalny opis (EN)
Trace one flow through a codebase and write it as a cited markdown map (Mermaid diagram plus stages with steps, reads and writes). Use when the user asks how a flow, feature or system works in a repo ("how does X work", "trace X", "map what happens when Y"), or wants a flow doc for onboarding, a PR review or AI-written code.
Jak działa
- Rules
- Steps
- Choices already made
- Strict mode (only when the user asks)
- Not in scope
Podgląd SKILL.md
---
name: codemap
description: Trace one flow through a codebase and write it as a cited markdown map (Mermaid diagram plus stages with steps, reads and writes). Use when the user asks how a flow, feature or system works in a repo ("how does X work", "trace X", "map what happens when Y"), or wants a flow doc for onboarding, a PR review or AI-written code.
---
# Codemap
Writes `docs/flows/<slug>.md`: a map of ONE flow in which every claim cites code. Read-only on the repo, except for that one file.
## Rules
1. **Cite only what a tool showed you in this session.** Copy `path:lines` from Read or `grep -n` output. Never write a line number from memory.
2. **A claim with no citation is not written.** The script rejects it.
3. **Do not drop a real hop on a hunch.** If you cannot prove a hop, keep it and mark it ⚠️ unsure.
4. **Stage level first.** 3 to 7 stages. Step over plumbing (auth, logging, retries, getters).
5. **Secrets stay out.** Never open `.env*`, keys, or git-ignored files. Never copy a secret value into the file.
6. **Be honest in the card.** Write `partial` and the reason if you stopped early or left hops unsure. Put doubts in the card's Doubts row.
## Steps
- [ ] **1. Scope.** Find 2 to 5 entry points with `grep` and the outline (routes, commands, handlers, jobs). Prefer the outermost handler. If the user did not name one, ask them to pick. Run `git rev-parse HEAD` and `git status --porcelain`.
- [ ] **2. Walk.** From the entry, follow the flow at stage level. For each hop note caller, callee, kind (`call`, `async`, `error`, `branch`) and the line that proves it. Stop at the end of the flow, at a third-party library, or after 40 hops (ask before going further).
- [ ] **3. Type each hop.** Direct: the callee's name is in the caller's lines (`grep -nw`). Anything else is indirect: a queue, a registry, a string dispatch, a callback. For an indirect hop, read the wiring yourself and follow it to where it is registered. Cite the wiring in the Evidence cell. If you cannot find the full chain, mark the hop ⚠️ unsure.
- [ ] **4. Shape it.** Cut the flow into 3 to 7 stages, with one level of steps inside each. Note each read and write with the line that does it.
- [ ] **5. Draft** the file from [TEMPLATE.md](TEMPLATE.md).
- [ ] **6. Run the check:** `python3 scripts/cite.py check <file>`. It is free. Fix every FAIL.
- [ ] **7. Tell the user** the path, the status, and the top doubts.
`scripts/` is in the folder that holds this SKILL.md.
## Choices already made
- Output: `docs/flows/<slug>.md`. Create the folder if needed.
- Links: GitHub permalinks with the commit sha when `git remote get-url origin` is a GitHub URL. Otherwise relative links.
- Depth: stages plus one level of steps.
## Strict mode (only when the user asks)
If the user wants a verified trace, also follow [RELIABILITY.md](RELIABILITY.md): a separate subagent checks each indirect hop. Do not run it by default. It costs the user's subscription.
## Not in scope
No edits to the repo, no running the code under study, no network calls. A flow that leaves the repo ends there, and the card says so.
Pliki w paczce (7)
- README.md 2 KB
- RELIABILITY.md 4 KB
- SKILL.md 3 KB
- TEMPLATE.md 4 KB
- .claude-plugin/plugin.json 1 KB
- examples/codemap-pipeline.md 40 KB
- scripts/cite.py 6 KB
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · capgoblin/codemap | 90 | MIT |
| jordancoin/codemap | 100 | MIT |
| AZidan/archflow | 100 | MIT |
| alvinunreal/oh-my-opencode-slim | 100 | MIT |
| jordancoin/codemap | 100 | MIT |
| ils15/copilot-global-config | 100 | MIT |
| azidan/codemap | 100 | MIT |
| ialameh/sift-coder | 100 | MIT |
| jellydn/my-ai-tools | 96 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki 3e19d50b8057 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 90rc-codemap
Buduje i odświeża pliki codemap.md w każdym katalogu jako tanią mapę struktury przed eksploracją dużego repozytorium. - 90sequence-flow
Śledzi prawdziwe wywołania w kodzie, by pokazać, jak żądanie lub funkcja działa w praktyce, i zapisuje diagram przepływu w dokumentacji. - 100architecture-overview
Czyta kod i zapisuje przegląd architektury projektu w trzech poziomach szczegółowości, z diagramami Mermaid w pliku docs/codemap. - 100codemap-export
Eksportuje mapę kodu (codemap) jako JSON do dalszego przetwarzania przez inne narzędzia, z tymi samymi danymi co polecenie /codemap. - 90flow-map
Rysuje, jak coś płynie od A do B, w trzech małych diagramach Mermaid sprawdzonych wobec źródeł, zapisuje je w Markdown i utrzymuje w aktualności. - 100code-flow-tracer
Śledzi ścieżki wykonania kodu i przepływ danych: jak działa dana funkcja, co się dzieje przy wywołaniu i skąd pochodzą dane.