内容
<div align="center">
**[English](README.md)** | [한국어](./docs/i18n/ko/README.md) | [日本語](./docs/i18n/ja/README.md) | [简体中文](./docs/i18n/zh-Hans/README.md) | [Español](./docs/i18n/es/README.md) | [Deutsch](./docs/i18n/de/README.md) | [Français](./docs/i18n/fr/README.md) | [Português](./docs/i18n/pt/README.md) | [Русский](./docs/i18n/ru/README.md) | [العربية](./docs/i18n/ar/README.md)
# 构建您自己的框架(BYOH)
### 您的人工智能代理,围绕您构建
*不是一个通用的模板 — 而是一个根据您的角色、专业知识和目标编译的框架。*
<img src="assets/features.png" width="100%" alt="构建您自己的框架">
</div>
大多数人工智能设置都提供一套固定的工具,并说“祝你好运”。BYOH则相反:它会采访你,了解你实际的工作内容,并生成一个个性化的代理框架 — 技能、代理、目标管道 — 直接适用于你的工作流程。
## 谁适合使用?
- **开发者**,他们希望拥有一个已经了解其技术栈、测试风格和交付节奏的代理
- **研究人员**,他们需要文献综述、引用跟踪和综合连接起来
- **创作者**,他们希望有一个写作伙伴,与他们的语气和项目结构相匹配
- **商业分析师**,他们需要决策框架和报告管道,而不是原始聊天
如果您曾经想过“我希望我的AI真正了解我的上下文” — 那么BYOH就是为您而设计的。
## 60秒了解工作原理
BYOH的设计初衷是驱动您的AI代理 — 而不是您手动输入命令。安装插件后,只需与之交谈即可。**对话即是采访、向导和构建**。
```
1. 安装插件 # Claude Code / Codex / agy — 自动安装二进制文件
2. "为我构建一个框架" # 您的代理采访您,构建,填充任何空白
# 它自己,并安装 — 全部在对话中
```
在下一次会话中,您的宿主会自动加载框架 — 调整到您需求的代理、技能和目标管道。
## 安装插件(推荐)
使用 **Claude Code, Codex, 或 agy**?安装插件。它捆绑了MCP服务器,并在**首次加载时自动安装二进制文件** — 无需Rust工具链,无需手动设置:
**Claude Code:**
```bash
claude plugin marketplace add epicsagas/BuildYourOwnHarness
claude plugin install byoh@epicsagas
```
**agy (Antigravity):**
```bash
agy plugin install /path/to/BuildYourOwnHarness
agy plugin enable byoh
```
**Codex:**
```bash
codex plugin marketplace add /path/to/BuildYourOwnHarness
codex plugin add byoh@epicsagas
```
### 使用其他MCP兼容宿主?
BYOH支持MCP,因此Cursor、Zed、Continue等也支持。安装 [二进制文件](#直接安装二进制文件) 一次,然后将宿主指向服务器:
```bash
byoh serve # stdio MCP 服务器
```
```json
{ "mcpServers": { "byoh": { "command": "byoh", "args": ["serve"] } } }
```
> **注意:** 目前仓库是私有的。使用上面的路径。一旦公开,它将出现在共享的`epicsagas/plugins`市场中。
## 直接安装二进制文件
仅当您 **不** 使用插件(插件会在首次会话时自动安装二进制文件)或您想在非插件MCP宿主上使用BYOH时需要。每个版本都会发布预构建的二进制文件 — 无需Rust工具链。
### macOS / Linux
```bash
curl --proto '=https' --tlsv1.2 -LsSf \
https://github.com/epicsagas/BuildYourOwnHarness/releases/latest/download/install.sh | sh
```
### Windows (PowerShell)
```powershell
irm https://github.com/epicsagas/BuildYourOwnHarness/releases/latest/download/install.ps1 | iex
```
### 从源码构建
```bash
cargo install byoh --git https://github.com/epicsagas/BuildYourOwnHarness
```
```bash
byoh --version # 验证
```
## 代理引导模式 — 主要路径
一旦您的宿主连接,您就不需要输入命令 — 只需与之交谈。您的代理直接调用BYOH的MCP工具,对话即是采访、构建和演化周期:
> **您:** *我是一个后端Go开发者,本月正在开发一个支付API。给我构建一个框架。*
>
> **代理:** *(通过`profile_scan`扫描您的仓库,提出几个有针对性的问题,通过`profile_interview`,锁定类型为`developer`)* → `build` 合成一个`HarnessBundle` 并将每个技能分类为 `matched` / `authored` / `skeleton` → 对于配置文件需要的任何骨架(例如,特定于支付的验证技能),代理在现场编写,通过 `author_skill`,然后再次 `build` 以确认 → 在Claude Code中安装代理、技能和安全交付目标管道。编写的内容在重新构建时持续存在。完成 — 下一次会话,您的代理已经掌握了您的技术栈。*
同样的流程,按建议的工具顺序:
```
profile_create → profile_scan → profile_interview → profile_confirm
→ build → (author_skill / author_doc 填充骨架) → build → install_plugin
```
`build` 合成捆绑包(编译 + 预设注入 + 静态门控)并将每个技能分类为 `matched`(真实预设主体)、`authored`(通过 `author_skill` 填充)或 `skeleton`(类型模板占位符)— 代理读取这些信息以决定是现在安装、编写骨架还是迭代配置文件。`author_skill` / `author_doc`写入配置文件覆盖层,`build` 读取回覆,以便编写的内容在每次重建时都得以保留。
可用工具:`profile_read`、`profile_create`、`profile_scan`、`profile_interview`、`profile_confirm`、`build`、`author_skill`、`author_doc`、`enable_hook`、`list_overrides`、`delete_override`、`render_plugin`、`install_plugin`、`catalog_search`、`catalog_vendor`。
想让代理引导您完成吗?只需说 *"构建我的框架"* — 捆绑的 `byoh-guide` 代理协调整个流程。
## 插件目录
目录是从 [`quemsah/awesome-claude-plugins`](https://github.com/quemsah/awesome-claude-plugins) README 构建的 — 一个社区维护的、按星级排名的Claude插件存储库前100名列表。BYOH附带一个预构建的捆绑包(**每周**,每个星期一03:17 UTC重新构建),因此 `byoh catalog index` 在几秒钟内解析;传递 `--no-bundle` 直接解析上游列表。
```bash
# 一次索引 — 在几秒钟内下载预构建的捆绑包
byoh catalog index
# 离线搜索 — 索引后无需网络
byoh catalog search "memory" --genre developer --limit 5
# 将插件添加到您的框架
# 许可证、关键词和类型从克隆的仓库中自动检测
byoh catalog vendor obra/superpowers --genre developer
```
LLM代理(通过 `catalog_search` / `catalog_vendor` MCP工具)可以自主完成整个流程 — *"在我的框架中添加一个内存插件"* — 或者您可以直接从CLI驱动它。
几个配套工具被植入搜索结果作为 **参考资料** (不是依赖项):BYOH自己的执行层工具 — [alcove](https://github.com/epicsagas/alcove) (文档服务器)、[obsidian-forge](https://github.com/epicsagas/obsidian-forge) (库自动化)、[epic-harness](https://github.com/epicsagas/epic-harness) (钩子/技能运行时)— 在上下文中显示(“文档服务器” / “搜索后端”查询找到alcove),以便代理在相关时推荐它们。仅当您实际需要时才提供;无论如何,捆绑包都无需依赖即可交付。
## 示例框架
使用上述流程构建的两个框架,并发布到GitHub — 每个都是多主机多语言插件(Claude Code · Codex · Antigravity),由技能、清单和(匹配时)仅代理组成,因此它在任何具有二进制文件的机器上运行:
- **[byoh-paper-whisperer](https://github.com/epicsagas/byoh-paper-whisperer)** — `researcher` 类型 · 13 技能 · 1 代理。调查、阅读、分析和记录AI/ML论文。捆绑的 *Research Analyst* 代理为每个声明标记证据等级(主要 > 同行评审 > 次要 > 传闻),并且永远不会高估来源;`search_citations` MCP 工具将引文检查连接到知识库 ([alcove](https://github.com/epicsagas/alcove))。
- **[byoh-market-gtm-analyst](https://github.com/epicsagas/byoh-market-gtm-analyst)** — `business` 类型 · 9 技能。范围市场/竞争研究参与(`goal`),运行证据分级市场和竞争对手分析(`analyze`),构建定位读取(`decide`),并生成具有每个渠道ROI和风险登记的GTM策略文档(`execute` / `roi_evaluation` / `risk_assessment`)— 所有这些都由相同的Critic / Seesaw / Stagnation安全门控。
```bash
# 在Claude Code中安装byoh-paper-whisperer
claude plugin marketplace add epicsagas/byoh-paper-whisperer
claude plugin install byoh-paper-whisperer@byoh-paper-whisperer
```
每个仓库的README都包含针对Codex和Antigravity的其他安装步骤。
## 高级用户:CLI(可选)
上述所有流程也可以从终端访问。CLI是 **辅助** 的 — 对于脚本、CI或您不想聊天时很有用 — 但代理引导路径是预期的。
### 您的第一个框架 — 从CLI
```bash
byoh profile init me --paths ./src ./docs # 自动扫描您的项目
byoh profile confirm me --genre developer # 锁定您的类型(+可选 --goal)
byoh render me --target claude # 合成(编译 + 预设注入 + 静态门控)并写入HarnessBundle;或:codex | agy | all(默认:all)
byoh install me --scope local # 渲染到dist/,激活到此项目的.claude/中
byoh install me --scope global # ...或 ~/.claude + ~/.codex + ~/.gemini(曾用 --host)
byoh install me --scope publish # ...或添加LICENSE + .gitignore并打印git指令
```
采访本身是由代理引导的(`profile_interview` MCP工具)— 对话就是采访,因此没有交互式CLI采访。构建的静态门控(Critic / Seesaw / Stagnation安全门控存在,MCP模式,钩子输入)始终运行,并且永远无法绕过 — 因此捆绑包在交付前在结构上有效。后期改进是后续会话的对话回顾,而不是工具调用。
## 底层工作原理
BYOH的合成引擎将您的配置文件标签与技能注册表匹配,将它们排序成一个依赖解析的管道,并发出一个`HarnessBundle` — 一个git-ready工件,渲染成任何支持的主机的原生格式。注册表未涵盖的技能将保留为骨架;代理通过`author_skill`填充它们,写入配置文件范围的覆盖层,下一构建读取回覆 — 因此编写的内容在每次重建时都保留,静态门控在每次构建时仍然运行。
- **4环安全模型** — 生命周期规范(Ring 0)和内置管道技能(Ring 1)通过社区/不受信任的技能(Ring 3),每个都有逐步验证;供应商技能通过sha256固定并在读取 + 嵌入时验证
- **3门安全底线** — 每个构建的静态门控确认Critic(质量)、Seesaw(回归)和Stagnation(平台)门控存在;无绕过
- **目标导向管道** — 声明30天目标(产品发布、研究报告、安全交付...)会自动覆盖匹配的技能梯度
架构:六边形 — `domain / ports / adapters / application / compiler / evolve / templates / deploy / catalog / mcp / i18n / security / cli`。参见 `AGENTS.md` 获取完整指南。
## 完整的CLI参考
CLI故意设计得很小:机器入口点(`serve`,`catalog index`在CI中,`vendor`供维护者使用)加上核心构建流程的可脚本化镜像。采访和演化仅限MCP(代理引导)。
```bash
# 配置文件
byoh profile init <slug> [--paths ...] # 非破坏性项目扫描
byoh profile confirm <slug> --genre <g> [--goal <text>] # 确认和锁定配置文件
byoh profile show <slug> # 打印配置文件YAML
# 构建(静态门控始终运行;渲染合成:编译 + 预设注入)
byoh render <slug> [--target <host>] # claude | codex | agy | all(默认:all);写入HarnessBundle
byoh install <slug> [--target <host>] [--scope local|global|publish] [--host] [--force] # dist/树;--scope决定它去哪里(local=此项目,global=HOME,publish=+LICENSE/.gitignore+git步骤)。--host是--scope global的遗留选项。
# 社区技能(维护者/构建时;sha256固定并在读取 + 嵌入时验证)
byoh vendor add <src> --genre <g> --id <id> [--keywords k1,k2] [--trust] [--sha <s>]
byoh vendor list
byoh vendor remove <id> --genre <g>
# 目录
byoh catalog index [--no-bundle] [--limit N]
byoh catalog search "<query>" [--genre <g>] [--tags k1,k2] [--limit N]
byoh catalog vendor <owner/repo> [--genre <g>] [--keywords k1,k2]
# 诊断/服务器
byoh doctor # 检查执行层工具
byoh serve # stdio MCP 服务器(代理引导模式)
```
配置文件和目录缓存默认存储在 `~/.byoh` 下(可通过 `BYOH_HOME` 覆盖)。
## 构建与开发
```bash
cargo build --release
cargo clippy --all-targets -- -D warnings
cargo test # 单元测试 + 端到端测试
cvp # 并行:检查 → 剪贴板 → 测试 → 格式化 → 构建
```
`mcp` 功能(_stdio MCP 服务器)默认启用。BYOH不附带嵌入式知识库 — 对于检索,请将生成的框架指向文档服务器,如 [alcove](https://github.com/epicsagas/alcove)。
## 致谢
BYOH建立在几个社区努力的肩膀上:
- **插件目录** — 来源于 [`quemsah/awesome-claude-plugins`](https://github.com/quemsah/awesome-claude-plugins),一个由星级排名的社区维护的Claude插件存储库前100名列表。如果没有它,目录就不会存在。
- **配套工具** — 设计用于与 [alcove](https://github.com/epicsagas/alcove) (文档服务器 / RAG)、[Episteme](https://github.com/epicsagas/Episteme) (知识图谱)和 [obsidian-forge](https://github.com/epicsagas/obsidian-forge) (库自动化)互操作。
- **开源栈** — 构建于 [clap](https://docs.rs/clap)、[serde](https://serde.rs)、[ureq](https://docs.rs/ureq) 和 Rust生态系统。
目录条目和供应商的社区技能保留其自身的许可证(在供应商时自动检测)。BYOH本身是Apache-2.0。
## 许可证
Apache-2.0。