Use when a project keeps its state in Superself (a `<!-- superself:begin` block in AGENTS.md or CLAUDE.md, or `self setup` resolves the directory to a registere
复制下面这句话,粘贴给 Claude Code、Codex、Cursor 等 AI 编程工具,它会读取安装说明并在你确认后完成安装。
请阅读 https://ai.atlankj.com/install/asset/gh-superself-10c279004f1f ,按照其中的说明把「superself」安装到你(当前 AI 工具)中。执行前先告诉我将运行的命令和写入的位置,等我确认。
查看 AI 将读取的安装说明正在读取 GitHub 原文…
内容来自 GitHub 原始文件,由原作者维护。在 GitHub 查看
Superself is an Apache-2.0 CLI (npm install -g superself@0.6.1, Node 22.12+) that
version-controls a project's state — goals, decisions, work units, reports —
as an append-only event log in a git repository separate from the code. The
state is derived on demand, so nothing in it is hand-maintained. This skill
tells an agent how to read and write that state through the self CLI. It is
maintained by the Superself authors: https://github.com/fxylabs/superself
AGENTS.md or CLAUDE.md contains a block between
<!-- superself:begin and <!-- superself:end -->, or self setup prints
the workspace, project, and store this directory resolves to.self --version fails: the project does not use
Superself, and nothing below should be invented by hand. This skill is
written against superself@0.6.1; a different major or minor version may
have moved a verb or flag, so check self <command> --help before relying
on one.self context and treat its output as current truth: the goal, active
decisions and conventions, open work, recent reports. It is folded from the
log, never written by hand.self search <query> finds live records context left out, and
self work show <id> prints one unit's full brief and report history.self work add "<required outcome>" — the outcome is what must become true,
not the task — then self work start <id>. start reads the brief and
records that this session picked the unit up; if another session holds it,
the CLI says who and since when and does not refuse. Judge and proceed.self report <id> "<what happened>". The
current HEAD commit is attached as evidence automatically; --evidence <commit|note> attaches something else, --file <path> attaches a longer
brief.self decide "<text>" --why "<reason>".
Use --proposed when the user has not confirmed it. One decision per event.self work block <id> --on decision|dependency|external --why "...".
Superseded or moved? self work retire <id> --why "..." [--successor <id>].
Never mark such a unit done, and never leave it falsely blocked.self work propose and its brief; the user accepts or declines it.self work add and the context behind it. A plan that lives only in the
conversation is lost when the conversation ends.self work done <id> closes a unit only when a report carries a commit or an
artifact, or the done itself states what verifiably happened:
self work done <id> --report "<what verifiably happened>". A bare claim is
refused, and declared criteria gate it until each is covered.--supersedes <id> on any add verb records the new wording and keeps the
lineage. retract withdraws a record with nothing replacing it..superself/.self setup first. If it
resolves the directory to a registered project, ask the user once whether
to run self connect, which writes the managed block into AGENTS.md or
CLAUDE.md. If it resolves no project, ask once whether to register it with
self project init. Never register or connect a project on your own.self --help lists every verb; self <command> --help prints one command's
flags without touching state. Topic guides ship with the CLI:
self help agents — how a session drives this CLI, start to finishself help context — what self context renders, and why something is missing from itself help records — one entity behind every record kind, and how a record is correctedself help placement — scope, priority and exposure — how a record earns its place in contextself help work — the work graph: outcomes, evidence, criteria, and proposalsself help goals — long-term goals, objectives, milestones, and what reaching one takesself help workspace — the store, the projects in it, and moving it between machines