kb-read
Skill15 starsChanged 25 days agoMITView on GitHub
Find what the Pointframe knowledge base says before you change or explain something - the sections, user-facing features (F-NN), and past-bug lessons for a file, an area, a feature ID, or a topic. Use before editing a file you have not worked on in this session; when asked how an area or feature works, where a feature lives, or what to watch out for.
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Run one command, then read only what it names:
- Very specific: line 25
Read each section it lists, at the line it gives.
- Very specific: line 27
Verify claims about behavior against the code before relying on them.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
/kb-read: what to read first
Run one command, then read only what it names:
pwsh scripts/kb.ps1 read <target> [<target> ...] [-All]| Target | Example | You get |
| A file or folder | Pointframe/Views/OverlayWindow.Recording.cs | Its File map rows, the features that use it, the narrowest sections to read in any knowledge base file with their size, and the five most relevant lessons.md entries (-All for every one) |
| An area | recording | The area file, its features, and its sections with line numbers |
| A feature ID | F-22 | Its trigger, entry point, telemetry events, tests, and sections |
| A topic | hotkey | Every feature and section heading that names it; when none does, the sections that mention it most |
| Nothing | The cross-cutting file and every area file with its feature IDs |
Then:
- Read each section it lists, at the line it gives. Read a lesson in
lessons.mdby its heading only when the change touches what the lesson describes. - A section is a
##or###heading and its text; a###section also costs its parent##preamble, and the size after each section is what reading it costs. The core isdocs/knowledge-base/knowledge-base.md(/kb-initprints it);file-map.md,composition.md,how-tos.md,maintenance.md,references.md,tooling.md,decisions.md, andworkflow.mdsit next to it, anddocs/knowledge-base/features/<area>.mdholds one area. Do not load files the task does not touch. - Verify claims about behavior against the code before relying on them. If the knowledge base is wrong or missing something, fix it with
/kb-writebefore finishing.
The project hook runs the same lookup when a session reads or edits a file, and says each section, feature, and lesson once per session, so you may already have this guidance in context. /kb-init <target> prints the same sections in full.
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
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.