my-module
my-module 模块的使用方法:my.add-card 建卡(title 必填,钩子门禁拦截空标题)、my.stats 统计、my.card 表单投影。当用户要在图里建卡/查卡,或会话中出现 my-module 时使用。
- License 许可
- MIT
- 所属仓库
- LUKAWI/toporealm
- 最近更新
- 2026-09-30
- Stars
- ★ 1
- Forks
- 0
01 前言 Front Matter
- name
- my-module
- description
- my-module 模块的使用方法:my.add-card 建卡(title 必填,钩子门禁拦截空标题)、my.stats 统计、my.card 表单投影。当用户要在图里建卡/查卡,或会话中出现 my-module 时使用。
03 SKILL.md 正文
my-module 使用指南(模块自带技能——随模块进池,经 toporealm skills index 到达 agent)
本技能是模块作者给 agent 的说明书模板:替换为你模块的真实命令、输入键与领域规则。
命令
toporealm my.add-card [card-id] --input '{"title":"...","priority":"mid"}'新建my.card;title必填且只能放--input(位置参数是目标实体 id,不是输入)。 空标题会被 before-commit 钩子否决(VETOED,details.vetoes[].module点名本模块)。toporealm my.stats— cards/links 统计。toporealm my.<命令> [target-id] --input '<json>'— 所有命令的权威清单:toporealm cmds --module my(目录永远等于注册事实;title 即输入键 schema)。
数据与所有权
- 本模块只触碰
my.card/my.links(module.yaml 词汇表 + 所有权法执法)。 - 钩子对一切来源生效(含人类直接
toporealm add)——绕过命令手写数据同样被门禁拦。 - 撤销是用户的手:
toporealm undo豁免领域门禁(D24①),钩子不得拦 undo/redo。 - 呈现声明:module.yaml
ui.kinds可给 kind 标represent: "container"(WebUI 容器分区, 成员经公共关系member_of挂靠,方向恒为 成员 → 类)或"annotation"(宿主角标/附属侧栏); 不声明即普通节点。
输入纪律
- 写命令人类输出带
[图名]前缀——先看图名再确认结果。 --json信封:成功{ok:true,data},失败读error.code/fix/hint(fix 是可执行建议)。
04 同仓库更多 Skills
example
Create example.card objects only when the current TopoRealm graph enables the example fixture module.
skilled-demo
Skilled fixture 模块的演示技能(host sync 双宿主投影用)。
toporealm
TopoRealm 图工作空间的 CLI 操作手册——建图选图、增删改查、撤销重做、模块能力动态发现。凡会话涉及图工作空间、TopoRealm、建图、任务拓扑、对象关系、工作流执行、undo 撤销、模块安装或技能发现——哪怕用户没明说"图"——都按本技能用 toporealm CLI 操作,绝不直接读写图文件。
toporealm-ops
TopoRealm 图生命周期运维——模块安装卸载与损坏自愈(module add/rm/list)、0.x 旧图迁移(migrate)、WebUI 启动(serve)、多图与专注图切换纪律、TOPOREALM_* 环境变量体系、daemon 排障(启动失败死因、空闲退出、socket/命名管道)。当用户要装/卸模块、迁旧图、起 WebUI、切图配环境变量,或 daemon 连不上/启动失败/WebUI 白屏时使用。Do not 讲日常读写图的动词用法(那是 toporealm 技能的事);Do not 触及图内数据建模(那是 toporealm-design 技能的事)。
toporealm-design
TopoRealm 图建模的机械原则——对象与关系怎么分、kind 粒度、payload 形状、id 策略与数据纪律。设计或评审图结构、决定一笔数据该 add 还是 link、规划 kind 与 payload、或遇到 UNKNOWN_KIND / DANGLING_RELATION / OWNERSHIP_VIOLATION 需要归因时使用。Do not 教任何业务方法论;Do not 替代 toporealm 技能的动词语法手册。
module-creator
TopoRealm 模块创建指南:从 modules-template 模板起步创建一个新模块——命名规则、module.yaml 声明层、activate 可注册面(命令/钩子/表单)、自包含构建、安装与验证。当用户要求创建 TopoRealm 模块/插件、脚手架模块,或询问模块结构时使用。