
文章正文
这份 Claude Code 工具源码属于本地配置管理类项目,主要围绕 CLAUDE.md 记忆文件与 import 导入块的安装、查看、卸载和备份恢复展开。
它把一个 Markdown 指令文件放进 keysmith 自己的管理目录,再向目标 CLAUDE.md 或 CLAUDE.local.md 插入一段带标记、可识别、可卸载的导入块。
工具只管理自己写进去的那一小段 block,不会覆盖整份用户文件,也不会去改 Claude Code 的 settings、MCP、凭证或二进制。
日常用法很直接:先不加 –yes 跑一遍预览,确认要改的文件路径、备份路径和导入块内容,再用 –yes 真正写入。
整套逻辑只用 Python 标准库实现,克隆下来即可运行,适合想规范化管理多份本地指令文件的 Claude Code 用户学习参考。
源码简介
这份 Claude Code 工具源码属于本地配置管理类项目,主要围绕 CLAUDE.md 记忆文件与 import 导入块的安装、查看、卸载和备份恢复展开。它把一个 Markdown 指令文件放进 keysmith 自己的管理目录,再向目标 CLAUDE.md 或 CLAUDE.local.md 插入一段带标记、可识别、可卸载的导入块。源码仅用 Python 标准库实现,默认只做预览,写入前自动备份,适合想规范化管理本地 Claude Code 指令文件的开发者学习与二次开发。
适用场景
- 想给 Claude Code 统一管理多份本地指令或规则文件时
- 在 user、project、local 多种作用域下维护 CLAUDE.md 导入块时
- 需要可预览、可回滚、可卸载的指令文件部署流程时
技术栈与运行环境
- 前端:无(命令行工具,终端交互)
- 后端:Python 3.8+ 标准库(argparse、pathlib、tempfile、re、json)
- 数据库:无
- 运行环境:Python 3.8 及以上,无需第三方运行时依赖
- 其他依赖:pytest(仅运行测试时需要)
功能亮点
- 多作用域导入块管理:支持 user、project、local 三种 scope,将指令文件写入 keysmith 管理目录并向 CLAUDE.md 插入可识别的 import block(证据:resolve_scope、render_import_block)
- 安装与卸载:install 写入指令文件与导入块,uninstall 仅移除自身管理的 block 并备份后删除对应文件(证据:command_install、command_uninstall、remove_import_block)
- 状态查看:status 检查指定 name 的导入块与指令文件是否存在,支持稳定 JSON 输出(证据:command_status、collect_status、has_import_block)
- 备份与恢复:写入前自动备份 CLAUDE.md 与指令文件,restore 可从指定备份路径恢复目标文件(证据:backup_file、command_restore)
- 安全默认值:默认 dry-run 预览不写入,–yes 才确认;–name 仅允许安全文件名并拒绝路径穿越(证据:preview_header、normalize_md_name)
- 原子写入:使用临时文件加 os.replace 保证写入原子性,降低半写入风险(证据:atomic_write_text)
安装与部署提示
- 环境要求本机已安装 Python 3.8 及以上,无需安装第三方依赖,克隆即用。
- 先预览安装:python3 claude-instruct.py install –scope project –project-dir /path/to/repo
- 确认写入:在上述命令末尾加 –yes;卸载用 uninstall,恢复用 restore 并指定备份文件路径。
安全风险提示
特别提示:本源码未检测安全风险文件,下载后请务必进行安全审计,删除恶意代码后再部署使用!
经源码检查,claude-keysmith 自身逻辑仅管理自己插入的 import block,不修改 Claude Code 的 settings.json、MCP 配置、凭证、二进制或运行中进程,未见加密、混淆或可疑远程加载代码。请仅将指令文件用于你拥有或获授权的本地项目配置。
下载说明
源码仅供学习研究、测试部署和二次开发参考,商用前请自行确认授权、版权和安全风险。
GitHub开源地址:https://github.com/Jia-Ethan/claude-keysmith
