¿Qué hace file-notes?
一个 Claude Skill + Python CLI 工具,用于记录文件和文件夹的用途与描述。
快速开始
安装
确保已安装 Python 3.8 或更高版本。
pip install file-notes
配置
首次运行前,设置一个本地存储路径(可选,默认使用用户目录)。
file-notes configure
使用方法
添加备注
file-notes add /path/to/file -d "这是项目的配置文件,包含数据库连接设置。"
查看备注
file-notes show /path/to/file
编辑备注
file-notes edit /path/to/file -d "更新描述:现在还包括日志级别设置。"
删除备注
file-notes remove /path/to/file
列出所有带备注的文件
file-notes list
与 Claude 集成
在 Claude 对话中,您可以直接使用自然语言来管理文件备注,例如:
- "添加文件备注:/home/user/config.json 是项目的配置文件。"
- "显示 /home/user/config.json 的备注。"
- "编辑 /home/user/config.json 的备注,更新为包含日志设置。"
平台支持
- Windows
- macOS
- Linux
数据存储
所有备注以 JSON 格式存储在本地,默认路径为 ~/.file_notes.json。您可以随时手动编辑或备份该文件。
许可证
MIT