harbor-spec 1.0.2b2

Harbor-spec v1.0.2 reference implementation (Python-only)

⚓ Harbor

The Context Governance Engine for Vibe Coding

让 AI 像代码一样被管理，让上下文像 Git 一样可追溯。

[理念 (Philosophy)] • [架构 (Architecture)] • [快速开始 (Quick Start)] • [工作流 (Workflow)]

---

🌌 The Era of Vibe Coding

编程正在经历一场范式转移。我们正在从 "Writing Code"（逐行编写）转向 "Vibe Coding"（通过自然语言与 AI 协作生成）。

在这个新时代，代码生成的边际成本趋近于零，但上下文维护的成本却在指数级上升。

• AI 改了代码，Docstring 还没改？👉 Context Drift (上下文漂移)
• 测试用例还在测旧版本的逻辑？👉 Validation Gap (验证断层)
• 为什么上周我们要把这个参数改成 Optional？👉 Memory Loss (决策遗忘)

Harbor 应运而生。它不是另一个 Copilot，它是 Copilot 的监管者。它是一套用于治理 AI 生成代码的 "良知" (Conscience) 与 "记忆" (Memory) 系统。它是“程序员到上下文工程师”这一革命性转变的关键工具，它的目标是成为vibe coding时代的Git。

🛡️ Core Philosophy

Harbor 的核心设计理念基于 L3 Contract Theory：

1. Code is Volatile, Contract is Immutable: 实现代码可以由 AI 随意重写，但 L3 级 Docstring（契约）是锚点，必须由人类或高级审计确认。
2. Noise is Signal: 未经索引的代码、未同步的文档、未绑定的测试，都是系统中的“噪音”。Harbor 不会静默处理，而是将其显性化。
3. Trust, but Verify: 我们信任 AI 的编码能力，但必须通过 AST 静态分析和 LLM 语义审计来验证其产出。

🏗️ Architecture

Harbor 通过六大核心子系统构建了一个闭环的治理体系：

graph TD
    Source[Source Code] -->|AST Parse| Adapter(Adapter)
    Adapter -->|Contract Hash| Index(L3 Index / Memory)
    
    Index -->|Compare| Sync(Sync Engine)
    Source -->|Body Hash| Sync
    
    Sync -->|Drift Detected| Status[CLI Status]
    Sync -->|Diff Target| Audit(Semantic Guard)
    
    Env[.env / LLM] --> Audit
    Audit -->|Semantic Check| Report[Audit Report]
    
    Tests[Test Cases] -->|DDT Binding| Validator(DDT Validator)
    Index -->|Version Match| Validator
    
    Index -->|Aggregation| L2(L2 Generator)
    Validator -->|Status| L2
    
    User[Developer] -->|Log Decision| Diary(Diary / History)

• 🧠 Index (Memory): 这里的 .harbor/cache 是大脑，记录了代码的每一次“快照”与指纹。
• ⚖️ Sync (Conscience): 实时监测 "Implementation Drift"（代码变了，但契约没变）。
• 🌉 DDT (Bridge): Decorator-driven Data Testing。将测试用例与 L3 版本强绑定，拒绝“假绿灯”。
• 🤖 Audit (Guard): 集成 DeepSeek/OpenAI，对代码进行语义级审计，揪出逻辑与文档的违背之处。
• 📊 L2 (Dashboard): 自动生成 Markdown 视图，诚实地展示模块的测试覆盖率与契约状态。
• 📜 Diary (History): 结构化的决策日志，记录每一次变革背后的 "Why"。

⚡ Quick Start

1. Installation

Harbor 是一个纯 Python 工具，推荐在开发模式下安装：

git clone [https://github.com/your-org/harbor-spec.git](https://github.com/your-org/harbor-spec.git)
cd harbor-spec
pip install -e .

可选pypi安装：

pip install harbor-spec

2. Configuration

配置 LLM 以启用 AI 语义审计（支持 Ernie, DeepSeek, OpenAI 等兼容接口）：

cp .env.example .env
# 编辑 .env 文件:
# HARBOR_LLM_PROVIDER=openai
# HARBOR_LLM_API_KEY=
# HARBOR_LLM_BASE_URL=https://api.openai.com/v1
# HARBOR_LANGUAGE=zh (可选，开启中文审计)

3. Initialize

使用智能初始化生成配置并避免 scanned=0：

harbor init
# 若已存在配置需要覆盖：
# harbor init --force

初始化完成后，构建初始索引接管当前代码库：

harbor build-index

4. 配置管理（Config CLI）

通过命令行安全管理 .harbor/config.yaml，避免手动编辑出错：

# 追加路径到 code_roots（自动去重）
harbor config add "backend/legacy/**"

# 查看当前配置（Rich 表格）
harbor config list

# 从 code_roots 移除路径
harbor config remove "backend/legacy/**"

运行 harbor config list 的示例输出：

Harbor Config
profile       : enforce_l3
code_roots    : harbor/**, backend/legacy/**
exclude_paths : .venv/**, tests/**, build/**, dist/**, docs/**

5. 进度可视化（Rich Progress）

在大型项目上构建索引支持进度条与当前文件显示，过程更透明：

harbor build-index --no-incremental

示例输出：

[完成] E:/project/harbor-spec/harbor/utils/__init__.py ━━━━━━━━━━━━━━━━━━━━━━━━━ 18/18 0:00:00
scanned=18 updated=18 skipped=0 items=63 cache=.harbor/cache/l3_index.json

Tips: 避免 scanned=0

• 先运行 harbor init 生成 .harbor/config.yaml，确保 code_roots 指向真实代码位置（如 src/** 或包目录）。
• 使用 --force 重新初始化以覆盖不合适的旧配置。
• 如为脚本型仓库（根目录只有若干 .py），harbor init 会生成 code_roots: ['*.py']；若没有 .py，会兜底为 ['**/*.py']。

🎮 Workflow: A Day with Harbor

1. Check Status

开始工作前，看看代码库是否干净。

harbor status
# 输出: No changes detected. (Or list of drifts)

2. Vibe Coding

使用你喜欢的 AI 助手（Cursor, Windsurf, Copilot）修改代码。 假设你修改了 harbor/utils.py 的逻辑，但忘记更新 Docstring。

3. Detect Drift

Harbor 会发现你的代码实现了“偷跑”。

harbor status
# 输出: M harbor.utils.func (Body changed, Contract static)

4. AI Audit

让 Harbor 的 AI 审计员检查你的修改是否违背了契约。

harbor audit --semantic --format plain
# 输出（plain 单行）：POSSIBLE_SEMANTIC_DRIFT harbor.utils.func :: 代码抛出 ValueError 但 Docstring 未声明
#
# 结构化输出（JSONL，一行一个结果，适合管道）：
harbor audit --semantic --format jsonl
# {"status":"POSSIBLE_SEMANTIC_DRIFT","func_id":"harbor.utils.func","file_path":"E:/project/.../utils.py","provider":"baidu","model":"ernie-4.0-turbo-8k","reason":"代码抛出 ValueError 但 Docstring 未声明"}

提示：

• 使用 --debug 可查看提示与原始 LLM 输出，便于故障排查。
• plain 模式自动压缩理由文本为单行，避免控制台断词或换行。
• jsonl 模式便于后续写入 Diary 或与其他工具联动。

5. AI 智能日志（Smart Diary）

当你准备记录一次重要变更的“为什么”和“做了什么”，可以让 Harbor 先为你生成一份 AI 草稿，然后在终端中确认或微调：

harbor diary draft --visibility repo
# 若遇到“AI 输出不可解析为 JSON”，可使用调试模式查看原始输出：
harbor diary draft --visibility repo --debug
# 过程:
# [Status] Analyzing code changes...
# [AI] Drafting diary entry...
# 终端展示 Panel:
# Summary: ...
# Type: refactor
# Importance: normal
# Details:
#   - 说明 WHY 和 WHAT（支持 Markdown）
#
# 提示: Save this entry? [Y]es / [e]dit summary / [n]o
# 选择 Y 写入；选择 e 可编辑 Summary 后写入；选择 n 放弃

前置条件：

• 已配置 LLM（见上文 Configuration），否则命令会友好提示配置 HARBOR_LLM_PROVIDER 和 HARBOR_LLM_API_KEY。
• 先运行 harbor status 确认存在 Drift/Modified；不要在生成草稿前运行 harbor build-index，否则差异会被快照消化。保存草稿后再运行 harbor build-index。

生成策略：

• 自动聚合 Drift/Modified 的受影响函数，提取源码片段（自动截断以避免超长上下文）。
• 通过 LLM 生成严格 JSON 的草稿字段：summary/type/importance/details。
• 可见性通过 --visibility 参数控制（默认 repo）。

兼容配置（ERNIE 示例）：

• .env 设置：
  • HARBOR_LLM_PROVIDER=openai
  • HARBOR_LLM_BASE_URL=<你的ERNIE OpenAI兼容端点>/v1
  • HARBOR_LLM_MODEL=ernie-4.0
  • HARBOR_LLM_API_KEY=<你的密钥>
  • HARBOR_LANGUAGE=zh

故障排查：

• 若端点不支持 response_format=json_object，可能返回包裹文本；使用 --debug 查看原始输出，或切换到支持结构化输出的模型。

6. Lock & Record

修复问题后，更新索引并记录决策日志。

harbor build-index
harbor diary log --summary "Refactor utils validation logic" --type refactor --importance high

🧩 Commands Cheatsheet

Command	Description
harbor init	智能探测项目结构并生成 .harbor/config.yaml（支持 --force 覆盖）
harbor status	检查代码与索引的差异（Drift检测）
harbor build-index	更新 L3 索引缓存 (类似 git commit)
harbor config list	使用 Rich 表格打印当前配置（profile、code_roots、exclude_paths）
harbor config add <path>	追加 <path> 到 code_roots（自动去重并写回）
harbor config remove <path>	从 code_roots 移除 <path>（写回配置）
harbor audit --semantic	调用 LLM 进行语义一致性检查（支持 --format jsonl）
harbor diary draft	AI 辅助生成决策日志草稿
harbor ddt validate	验证测试用例与代码版本的绑定关系
harbor gen l2 --module <module> [--write]	生成指定模块的 L2 README（默认预览，--write 写入）
harbor diary log	写入结构化的决策日志

📊 生成 L2（Anchor）教程

L2 是基于 L3 Docstring 的只读聚合视图，用于在模块目录生成 README.md，展示 Public API、严格度与 DDT 绑定状态。请勿手动编辑生成的 L2 文件。

• 前置准备
  • 运行 harbor init 完成初始化与 code_roots 配置
  • 构建索引：harbor build-index（读取并更新 .harbor/cache/l3_index.json）
• 生成步骤
  • 执行：harbor gen l2 --module harbor/core --write
  • 工具会扫描 code_roots，基于索引为每个模块目录生成/更新 README.md
• 成品内容
  • Public API：函数名、摘要、strictness、DDT Status
  • Internal Details（可选）：模块内的内部函数视图
  • Dependency (MVP)：依赖占位视图（后续版本完善）
• 示例

  harbor build-index
  harbor gen l2 --module harbor/core
  harbor gen l2 --module harbor/core --write
  # 例如会生成：
  # harbor/core/README.md
  

• 更新策略
  • 当 Docstring 或实现变更后：先 harbor build-index，再 harbor gen l2
  • L2 文件包含头部标识：AUTO-GENERATED ... DO NOT EDIT MANUALLY，请保持只读

🧭 命令用法速查

• 预览（不写文件）：harbor gen l2 --module harbor/core
• 写入 README：harbor gen l2 --module harbor/core --write
• 覆盖已有 README：在写入模式下追加 --force

🤝 Contribution

Harbor 遵循 Strict L3 开发规范。

• 所有 Public API 必须包含完整的 Google-style Docstring。
• 所有新增功能必须包含 DDT 测试绑定。
• 提交前请运行 harbor audit --semantic 自测。

📄 License

MIT © 2025 Harbor-spec Authors.