workspace-git-setup

一条命令即可为任意工作目录配置安全、合理 Git 版本控制 —— 内置安全审计功能。

一个零依赖的 Bash 脚本，用于为项目初始化 Git 版本控制，附带经过实战验证的安全 .gitignore 文件，在首次提交前警告大文件，并可对现有仓库进行敏感信息泄露与未跟踪文件审计。

纯 bash + git 实现。无需 Python、npm 或任何第三方包。

• 作者: Evan Song · github.com/Songhonglei
• 代码仓库: https://github.com/Songhonglei/better-agent-skills
• 许可证: MIT

使用方法

# 初始化 / 对齐配置（默认作用于当前目录；自动以目录名作为项目名）
bash scripts/setup.sh

# 指定工作区路径与项目名
bash scripts/setup.sh /path/to/project "MyProject"

# 审计模式（只读）：检测敏感文件 / 未跟踪文件 / 配置项
bash scripts/setup.sh --audit

# 模拟运行模式：预览所有操作，但不实际执行
bash scripts/setup.sh --dry-run

路径与身份解析规则

若仅提供邮箱地址，则使用邮箱前缀（@ 符号之前部分）作为用户名（后续可通过 git config 修改）。

三种运行模式

默认流程（init 模式）

1. 解析路径 — CLI 参数 > WORKSPACE_DIR > 当前目录
2. 推导项目名 — 使用工作区 basename（可通过第二个参数覆盖）
3. 读取 Git 身份 — 环境变量 → 已存在 git 配置 → 交互式提示
4. 执行 git init — 若仓库已存在则跳过（幂等）；设置 core.autocrlf=input 统一行尾格式；默认分支名为 main
5. 写入 .gitignore — 若该文件已存在，则显示 diff 并询问是否覆盖
6. 大文件警告 — 扫描大于 10MB 的待追踪文件，并请求确认
7. 首次提交 — 自动暂存并提交
8. 汇总信息 — 显示项目名、路径、Git 身份及审计使用提示

默认 .gitignore 规则（通用安全用途）

注意：私钥忽略规则限定在 **/certs/*.key（而非宽泛的 *.key），以避免误隐藏其他位置合法使用的 .key 文件。

审计模式（--audit）

一次只读运行，输出三项检查结果，绝不修改任何内容：

1. 敏感文件检测 — 列出已被 Git 追踪的私钥 / Token / 凭证文件。仅发出警告，提供人工复核指引，不执行任何破坏性操作。
2. 未跟踪文件检测 — 列出既未被 git add 也未被 .gitignore 忽略的文件。
3. 配置检查 — 检查 core.autocrlf 是否合理，以及 .gitignore 是否存在。

注意事项

• 仅初始化本地 Git 仓库，不添加远程仓库；就绪后请手动添加：git remote add origin
• 脚本具有幂等性，可安全重复运行；已有配置将被保留。
• 若 .gitignore 已存在，会显示 diff 并由用户决定是否覆盖。
• 审计仅对已被追踪的敏感文件发出警告 — 如何移除由您自行决定。
• 当环境变量与 git 配置中均未找到 Git 身份信息时，脚本将回退至交互式提示（若不设置环境变量，则无法无人值守运行）。

依赖项

• git（必需）— https://git-scm.com/downloads
• bash 4.0+
• coreutils（含 numfmt/stat/realpath）— 大多数类 Unix 系统已预装；numfmt 为可选依赖（缺失时将回退至原始字节计数）。

纯 bash + git 实现，无需 Python 或任何第三方包。