cskwork/claude-code-mods/tree/main/template
mod-template
Claude Code mod 入门模板,包含斜杠命令、状态栏条目、提示框上方的栏位,以及带测试的 $.state 契约,通过 cskwork/claude-code-mods marketplace 安装。
关于这个 mod
claude-code-mods
Claude Code 的 mod(2.1.287+):通过 function hooks 观察、重写或回答 Claude Code 的行为,并绘制自己的界面。基于 Getting started with Claude Code mods。
主页:https://cskwork.github.io/claude-code-mods/
| Mod | 功能 |
| --- | --- |
| token-weather | 提示框上方显示上下文窗口的一行预报:☀ Clear → ↯ Compact soon、已用 token、最近 12 个工作阶段的火花线,以及上一轮增加了多少。 |
| blast-radius | 在高风险 Bash 命令运行前(递归 rm、git reset --hard、git clean -f、强制推送、git branch -D、git stash drop/clear、kubectl delete、SQL DROP/TRUNCATE、迁移)先试运行它会影响什么,并询问 Proceed 或 Cancel。取消或关闭都会拒绝调用。 |
| template | 入门 mod,未安装:包含斜杠命令、状态栏条目、栏位,以及带测试的 $.state 契约。 |
安装
在 Claude Code 中:
/plugin marketplace add cskwork/claude-code-mods
/plugin install token-weather@claude-code-mods
/plugin install blast-radius@claude-code-mods
/reload-plugins
创建新 mod
scripts/new-mod.sh my-mod "One line about what it does"
claude --plugin-dir "$PWD/my-mod" # hot-reloads on every save
该脚本会复制 template/,重命名它,将其加入 .claude-plugin/marketplace.json,然后运行 claude plugin validate 和 claude plugin test。
一个 mod 由 3 个文件和一个可选的状态契约组成:
my-mod/
├── .claude-plugin/plugin.json name, version, description, "types"
├── hooks/hooks.json { "modules": ["./register.tsx"] }
├── hooks/register.tsx export const register: Register = on => { ... }
├── types/index.d.ts PluginState contract for $.state values
└── tests/my-mod.test.ts claude plugin test my-mod
容易踩坑的规则:
- 每个 hook 都是
($, e, next)。调用next(e)继续传递,调用next({ ...e, x })重写,不调用它直接返回则回答。 - 将值保存在
$.state(atom/read/update)中;每次热重载时模块变量都会重置。 - 没有 Node,也没有 DOM:文件、进程、时钟和 UI 都通过
$使用。UI 元素来自$.ui.resolve(e)。 - 测试 mock 也是 hook:
on('process.run', ($, e) => ({ value: ... }))。 - 引擎加载 mod 后,会在 mod 旁写入
.claude-plugin/types/,因此tsc -p <mod>可以对它进行类型检查(该目录被 gitignore)。
检查
for m in token-weather blast-radius template; do claude plugin validate $m && claude plugin test $m; done
安装
请先查看作者 README 确认 marketplace 和插件名称;命令可能随仓库结构改变。
claude plugin marketplace add cskwork/claude-code-mods claude plugin install mod-template
原文 / README
claude-code-mods
Mods for Claude Code (2.1.287+): plugins of function hooks that observe, rewrite or answer what Claude Code does and draw their own UI. Based on Getting started with Claude Code mods.
Landing page: https://cskwork.github.io/claude-code-mods/
| Mod | What it does |
| --- | --- |
| token-weather | A one-line forecast of the context window above the prompt: ☀ Clear → ↯ Compact soon, tokens used, a sparkline of the last 12 turns, and how much the last turn added. |
| blast-radius | Before a risky Bash command runs (recursive rm, git reset --hard, git clean -f, force push, git branch -D, git stash drop/clear, kubectl delete, SQL DROP/TRUNCATE, migrations), dry-runs what it would touch and asks Proceed or Cancel. Cancel or dismiss denies the call. |
| template | Starter mod, not installed: a slash command, a status line entry, a band, and a $.state contract with a test. |
Install
Inside Claude Code:
/plugin marketplace add cskwork/claude-code-mods
/plugin install token-weather@claude-code-mods
/plugin install blast-radius@claude-code-mods
/reload-plugins
Make a new mod
scripts/new-mod.sh my-mod "One line about what it does"
claude --plugin-dir "$PWD/my-mod" # hot-reloads on every save
The script copies template/, renames it, adds it to .claude-plugin/marketplace.json,
then runs claude plugin validate and claude plugin test on it.
A mod is three files plus an optional state contract:
my-mod/
├── .claude-plugin/plugin.json name, version, description, "types"
├── hooks/hooks.json { "modules": ["./register.tsx"] }
├── hooks/register.tsx export const register: Register = on => { ... }
├── types/index.d.ts PluginState contract for $.state values
└── tests/my-mod.test.ts claude plugin test my-mod
Rules that bite:
- Every hook is
($, e, next). Callnext(e)to pass on,next({ ...e, x })to rewrite, return without it to answer. - Keep values in
$.state(atom/read/update); module variables reset on every hot reload. - No Node, no DOM: files, processes, clock and UI go through
$. UI elements come from$.ui.resolve(e). - Test mocks are hooks too:
on('process.run', ($, e) => ({ value: ... })). - After the engine loads a mod it writes
.claude-plugin/types/beside it, sotsc -p <mod>type-checks it (gitignored).
Check
for m in token-weather blast-radius template; do claude plugin validate $m && claude plugin test $m; done
