个人脚本仓库

这里收纳用于本地开发、仓库维护和自动化处理的可复用脚本。

目录结构

.
├── bin/          # 可执行脚本入口
├── docs/         # 非简单脚本的使用说明
├── lib/          # 共享辅助模块，仅在确有复用时添加
├── examples/     # 可选的示例配置或调用方式
└── README.md     # 脚本索引与约定说明

可用脚本

命令	用途	文档
zread-generate	生成 .zread 文档，并支持重试与草稿续跑	docs/zread-generate.md

使用准备

可以直接通过解释器运行脚本：

node bin/zread-generate --cwd /path/to/repo

如果希望在整个 shell 环境中直接调用命令，可以把本仓库的 bin 目录加入 PATH：

export PATH="/path/to/scripts/bin:$PATH"

之后即可直接运行：

zread-generate --cwd /path/to/repo

脚本约定

• 可执行入口统一放在 bin/。
• 命令名使用清晰的短横线形式，例如 zread-generate。
• 在确实需要共享逻辑之前，优先保持每个脚本自包含。
• 只有在至少两个脚本都需要复用时，才把共享辅助代码放进 lib/。
• 如果脚本带有参数、依赖外部工具、存在副作用，或失败模式不直观，应为其补充 docs/<script-name>.md 文档。
• 优先使用标准库，而不是新增依赖。
• 脚本应输出可执行的进度信息，并返回有意义的退出码。
• 会写入文件的脚本，需要明确说明写入位置。

新增脚本流程

1. 创建带 shebang 的 bin/<name> 文件。
2. 赋予可执行权限：chmod +x bin/<name>。
3. 在 docs/<name>.md 下补充聚焦的使用文档。
4. 在本 README 的脚本索引中新增对应条目。
5. 提交前至少运行一次语法检查或基本冒烟验证。

备注

生成物、缓存、凭据以及一次性下载内容不应提交到 git。只有当某类文件很可能持续出现时，才添加对应的忽略规则。