复制下面这句话,粘贴给 Claude Code、Codex、Cursor 等 AI 编程工具,它会读取安装说明并在你确认后完成安装。
请阅读 https://ai.atlankj.com/install/asset/gh-system-atlas-039f7bc79924 ,按照其中的说明把「system-atlas」安装到你(当前 AI 工具)中。执行前先告诉我将运行的命令和写入的位置,等我确认。
查看 AI 将读取的安装说明正在读取 GitHub 原文…
内容来自 GitHub 原始文件,由原作者维护。在 GitHub 查看
An atlas is one data file (data.mjs) that renders two views: an interactive isometric map (a single self-contained atlas.html — hover to read, click to pin, go inside for steps, moving data packets you can inspect, chapters that reveal the system a few structures at a time), and a generated text twin (SYSTEM.md) with the decisions table, every structure, the flows, and the open questions by ID. The data file is the only thing anyone edits; both views rebuild from it. It sits beside a hand-written glossary (CONTEXT.md) and ADRs.
Does: interactive architecture maps with progressive disclosure, question tracking across feedback rounds, a generated text twin, and a repeatable update loop. Doesn't: static one-off diagrams (use the architecture-diagram or excalidraw skill), finished systems that only need a README, or a single diagram for a PR.
Use whenever someone wants to discuss, design, review, or explain an architecture visually — "make an atlas", "map the system", "make the architecture explorable", "visualize the codebase/agent/pipeline so we can talk about it", "a diagram I can click around", "walk me through how it fits together" — or when an architecture discussion is producing a pile of open questions that need tracking across feedback rounds. Also use it to update an existing atlas after decisions change. Best when the system is new enough that vocabulary, decisions, and questions are still moving and there will be more than one feedback round.
node:fs, node:path, node:url — no npm install needed).npx serve or python3 -m http.server).mkdir -p <atlas home>/atlas
cp <skill>/assets/{template.html,build.mjs} <atlas home>/atlas/
cp <skill>/assets/data.example.mjs <atlas home>/atlas/data.mjs # then fill it in
node <atlas home>/atlas/build.mjs # writes ../SYSTEM.md and ../atlas.html
Every field of the data file is documented in assets/data.example.mjs.
| File | Role | Edit it? |
|---|---|---|
atlas/data.mjs | Single source of truth: structures, flows, chapters, decisions, questions, prose | Yes |
atlas/template.html + atlas/build.mjs | Renderer + generator | Presentation only |
atlas.html | Built atlas; republish at the same URL after every rebuild | No (generated) |
SYSTEM.md | Built text twin | No (generated) |
CONTEXT.md | Glossary, one line per noun | By hand |
adr/ | Hard-to-reverse decisions | By hand |
research/ | Deep-dive evidence | Append-only |
Follow the order — each step was earned by a correction the first time round.
delegate_task with your specific design questions and have it return a primer with gotchas and a "what it does not give us" list. Drawing before this produces boxes that don't map to anything real.assets/ into the atlas home (rename data.example.mjs to data.mjs), fill the data, build with node, publish. Where the atlas home is depends on the repo's docs policy — ask before committing anything. Docs-friendly repos: docs/<system>/atlas/ in-tree. Repos that commit only ADRs and CONTEXT.md: put the atlas, SYSTEM.md, and research/ in a git-ignored scratch dir and attach SYSTEM.md + research to the spec issue when published. (Committing the whole set once produced a 3,900-line docs PR and four review rounds reconciling three restatements of one design.) Load the design-md or architecture-diagram skill via skill_view for HTML-artifact guidance if useful; read references/design-language.md for the visual rules either way.CONTEXT.md is a glossary and nothing else (the nouns, one line each); ADRs only for decisions that are hard to reverse, surprising without context, and the result of a real trade-off — these two are the in-tree pieces. SYSTEM.md is generated and research/ holds evidence; both live with the atlas (scratch dir or docs/, per step 3). Don't open issues unless asked.Q-<code><n> with a state: open (a string), resolved (answer + date), or routed (handed to a named next step). Record the user's words. If they call something "not a question", drop it; if they say "I don't get this", explain with a concrete example resolving. After each round: rebuild, republish, update memory.atlas.html is one self-contained file — no build step, no external assets beyond a Google Fonts stylesheet. Serve the folder with any static server (npx serve, python3 -m http.server) and hand over the URL, or let the repo's pages host serve the committed file. One URL, republished after every data change, never a second copy. If you keep a stable published URL, put it in META.artifactUrl so SYSTEM.md links to it.
<!doctype html> first and <meta charset="utf-8"> immediately after — otherwise quirks mode and mojibake arrows.render() in a hover handler detaches the element under the cursor and the browser stops synthesising clicks — the map looks perfect in a screenshot while nothing responds.file:// as a static snapshot; verify via a static server, not from disk.pending, the old model name, the rejected design) — the person reads everything.write_file and keep the data block JSON-serializable.node <atlas home>/atlas/build.mjs exits 0 and writes both SYSTEM.md and atlas.html.new Function(js)), then open the served page in a real browser at ~1280×800; check a first chapter, a middle chapter, the last chapter, an inside view, and the light theme.one, what, how, a short label, a role kind, and its questions; ghosts are marked; chapters exist with per-chapter flows; the last chapter is the whole system.SYSTEM.md carries the decisions table, the question index with IDs and states, and the "how this file is maintained" footer.{q, r}{q, to}delegate_task) against one shared brief (the interface we own, the requirements that separate candidates, a usage model for cost, a fixed deliverable shape). Write a synthesis with a normalized cost/fit grid. Fold resolutions into the data as {q, r: '… (from the deep dive, date)'}. If the user rejects a proposal, sweep every file and rewrite — a banner on top of a stale section is not enough.README.md in the docs folder explaining the set (table in references/process-and-lessons.md).