Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Choose the host you already use to get its exact installation, verification,
invocation, and report-output steps. Better Harness does not use one universal
entrypoint across every host.

The canonical registry covers eight host adapters. Pi and WorkBuddy currently
The canonical registry covers nine host adapters. Pi, WorkBuddy, and Grok currently
remain adapter-support entries rather than part of the six-host verified
Quickstart; see the [public Host Adapter Matrix](docs/docs/hosts/adapter-matrix.md)
for their explicit boundaries.
Expand Down
2 changes: 1 addition & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
选择你正在使用的宿主,查看对应的安装、验证、调用和报告输出说明。
不同宿主的入口并不完全相同,请直接使用对应章节给出的命令。

规范注册表当前包含八个宿主适配器。Pi 与 WorkBuddy 仍属于适配器支持入口,
规范注册表当前包含九个宿主适配器。Pi、WorkBuddyGrok 仍属于适配器支持入口,
没有进入包含六个宿主的已验证快速开始;具体边界见
[公开宿主适配矩阵](docs/docs/hosts/adapter-matrix.md)。

Expand Down
4 changes: 2 additions & 2 deletions assets/better-harness-architecture-en.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 16 additions & 4 deletions docs/adapters/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Host Adapter Matrix

This is the single entry point for Claude Code, Codex, Qoder, Cursor, Qwen,
GitHub Copilot, Pi, and WorkBuddy host boundaries. Do not create `docs/adapters/claude-code.md`,
GitHub Copilot, Pi, WorkBuddy, and Grok host boundaries. Do not create `docs/adapters/claude-code.md`,
`docs/adapters/codex.md`, `docs/adapters/qoder.md`, `docs/adapters/cursor.md`,
`docs/adapters/qwen.md`, `docs/adapters/copilot.md`, `docs/adapters/pi.md`, or
`docs/adapters/workbuddy.md` by default.
`docs/adapters/qwen.md`, `docs/adapters/copilot.md`, `docs/adapters/pi.md`,
`docs/adapters/workbuddy.md`, or `docs/adapters/grok.md` by default.

Adding another host? Follow
[Contributing a New Coding Agent Host](contributing-new-coding-agent.md) before
Expand Down Expand Up @@ -35,6 +35,7 @@ package through the `pi` manifest in `package.json`.
| GitHub Copilot | Analysis-capable source-local host | `.github/plugin/` | `scripts/agent-customize/providers/copilot.mjs` | `scripts/session-analysis/platforms/copilot.mjs` | self-contained HTML + Markdown | `.github` + `AGENTS.md` + `~/.copilot` | `copilot plugin marketplace add .` -> `copilot plugin install better-harness@better-harness` -> configured-asset baseline -> validated `html` render |
| Pi | Analysis-capable source-local host | `pi` manifest in `package.json` | `scripts/agent-customize/providers/pi.mjs` | `scripts/session-analysis/platforms/pi.mjs` | self-contained HTML + Markdown | `.pi` + `.agents` + `AGENTS.md` | `pi install <source>` or `pi -e <source>` -> `/better-harness` prompt template -> validated `html` render |
| WorkBuddy | Analysis-capable source-local host | none (skills install into `~/.workbuddy/skills`) | `scripts/agent-customize/providers/workbuddy.mjs` | `scripts/session-analysis/platforms/workbuddy.mjs` | self-contained HTML + Markdown | `~/.workbuddy` `AGENTS.md` + identity files + `.agents` + `AGENTS.md` | `session-analysis --platform workbuddy sources` -> validated `html` render |
| Grok | Analysis-capable source-local host | none (skills install into `~/.grok/skills`) | `scripts/agent-customize/providers/grok.mjs` | `scripts/session-analysis/platforms/grok.mjs` | self-contained HTML + Markdown | `~/.grok` + `.grok` + `.agents` + `AGENTS.md` | `session-analysis --platform grok sources` -> skill symlink -> validated `html` render |

## Discovery And Evidence

Expand Down Expand Up @@ -109,6 +110,17 @@ package through the `pi` manifest in `package.json`.
override. WorkBuddy has no install shell in
this repository; skills install manually into `~/.workbuddy/skills` or
through WorkBuddy's own marketplace surfaces.
- Grok configured assets are inventoried through
`scripts/agent-customize/providers/grok.mjs`, covering `~/.grok` user skills
(including bundled skills), hooks, MCP servers declared in `config.toml`,
installed plugins under `installed-plugins/`, shared `.agents/skills`, and
project `.grok` assets. Session evidence comes from
`scripts/session-analysis/platforms/grok.mjs`, which reads workspace-matching
session directories under `~/.grok/sessions/<url-encoded-cwd>/<session-id>/`
(`summary.json`, `updates.jsonl`, optional `chat_history.jsonl` and
`signals.json`). The adapter honors `GROK_HOME`. Grok has no install shell in
this repository; skills install manually into `~/.grok/skills` (symlink is
enough for `/better-harness`).

## Output Modes

Expand All @@ -118,7 +130,7 @@ Canonical templates live under `templates/reporting/`.
`findings.json`, Canvas-only `canvas.json`, and `report.canvas.tsx`.
- `cursor-canvas.md`: Cursor Canvas output contract, covering the complete
report, native Context Usage projection, and public IDE actions.
- `html-visual.md`: portable Claude Code/Codex/Qwen/Copilot/Pi/WorkBuddy visual output contract, covering
- `html-visual.md`: portable Claude Code/Codex/Qwen/Copilot/Pi/WorkBuddy/Grok visual output contract, covering
`findings.json`, `report.md`, and `report.html`.
- Markdown-only output has no visual companion.

Expand Down
16 changes: 13 additions & 3 deletions docs/docs/hosts/adapter-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ host-neutral.

## Support levels

Better Harness currently declares eight capability-level host adapters. Six
have verified public Quickstart paths. Pi and WorkBuddy are visible as adapter
Better Harness currently declares nine capability-level host adapters. Six
have verified public Quickstart paths. Pi, WorkBuddy, and Grok are visible as adapter
support because their installation and end-to-end evidence boundaries differ
from that six-host set. The [canonical adapter matrix](https://github.com/QoderAI/better-harness/blob/main/docs/adapters/README.md)
remains the complete capability-level source of truth.
Expand All @@ -31,6 +31,7 @@ remains the complete capability-level source of truth.
| GitHub Copilot | Verified Quickstart | Analysis-capable source-local host | `.github/plugin/` | Workspace-matched Copilot CLI transcripts; partial coverage stays explicit | Self-contained HTML + Markdown |
| Pi | Adapter support | Analysis-capable source-local host | `pi` manifest in `package.json` | Workspace-matching local Pi sessions | Self-contained HTML + Markdown |
| WorkBuddy | Adapter support | Analysis-capable source-local host | None; skills use WorkBuddy-owned paths | Workspace-matching WorkBuddy JSONL transcripts | Self-contained HTML + Markdown |
| Grok | Adapter support | Analysis-capable source-local host | None; skills use Grok-owned paths | Workspace-matching Grok session dirs (`updates.jsonl`) | Self-contained HTML + Markdown |

The `@qoderai/better-harness` npm package includes all six plugin metadata
roots. Pi reuses install metadata in the existing `package.json`, so it does
Expand All @@ -44,7 +45,7 @@ source-local.
`canvas.json`, and `report.canvas.tsx`.
- **Cursor Canvas** — the same complete report contract rendered with
`cursor/canvas`, native Context Window evidence, and IDE actions.
- **HTML visual** — portable Claude Code/Codex/Qwen/Copilot/Pi/WorkBuddy contract
- **HTML visual** — portable Claude Code/Codex/Qwen/Copilot/Pi/WorkBuddy/Grok contract
covering `findings.json`, `report.md`, and a self-contained `report.html`
(see the [sample report](pathname:///demo/better-harness-report/)).
- **Markdown-only** — no visual companion.
Expand All @@ -66,6 +67,15 @@ HTML routing are implemented. This repository does not ship a WorkBuddy install
shell, plugin manifest, or npm-packaged host artifact; installation remains on
WorkBuddy's own `~/.workbuddy/skills` or marketplace surfaces.

### Grok {#grok}

Grok configured assets, workspace-matched session evidence, and portable HTML
routing are implemented. This repository does not ship a Grok install shell or
npm-packaged host artifact; installation is a manual skill symlink into
`~/.grok/skills/better-harness` (or project `.grok/skills`). Grok remains
outside the verified Quickstart set until a complete interactive report-loop
smoke is observed.

## Capability coverage

Capabilities differ per host on purpose: no host claims a capability without a
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Cursor's source-local path also requires Git so you can clone this repository.
:::tip Don't see your Coding Agent?

The six tabs below are the verified Quickstart paths, while the project tracks
eight host adapters in total. [Compare all adapter support boundaries](./hosts/adapter-matrix),
nine host adapters in total. [Compare all adapter support boundaries](./hosts/adapter-matrix),
then [follow the new-host contribution workflow and worked pull requests](./hosts/contributing-new-coding-agent)
if you want to add or complete an integration. You can also
[browse current repository pull requests](https://github.com/QoderAI/better-harness/pulls)
Expand Down
12 changes: 9 additions & 3 deletions docs/i18n/zh-Hans/code.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@
"homepage.hosts.workBuddy.setup": {
"message": "证据与报告适配器已可用;安装仍通过 WorkBuddy 自有路径完成。"
},
"homepage.hosts.grok.method": {
"message": "Skill 软链路径"
},
"homepage.hosts.grok.setup": {
"message": "证据与报告适配器已可用;安装方式是把 Skill 软链到 ~/.grok/skills。"
},
"homepage.hosts.output.html": {
"message": "HTML + Markdown 报告"
},
Expand Down Expand Up @@ -186,16 +192,16 @@
"message": "Agent Work Loop(智能体工作循环)"
},
"homepage.how.architectureCaption": {
"message": "八个能力层宿主适配器进入同一条证据流水线。其中六个已有验证过的快速开始路径;Pi 与 WorkBuddy 的当前适配器支持边界会明确展示。"
"message": "九个能力层宿主适配器进入同一条证据流水线。其中六个已有验证过的快速开始路径;Pi、WorkBuddyGrok 的当前适配器支持边界会明确展示。"
},
"homepage.how.architectureAlt": {
"message": "Better Harness 架构:六个公开快速开始宿主以及 Pi 与 WorkBuddy 适配器支持进入三个独立证据智能体,再进行统一分析、宿主中立输出和修复"
"message": "Better Harness 架构:六个公开快速开始宿主以及 Pi、WorkBuddyGrok 适配器支持进入三个独立证据智能体,再进行统一分析、宿主中立输出和修复"
},
"homepage.quickstart.title": {
"message": "选择你的 Coding Agent"
},
"homepage.quickstart.intro": {
"message": "目前支持八个宿主适配器。其中六个已有验证过的配置路径;Pi 与 WorkBuddy 会进入各自当前的支持边界说明。"
"message": "目前支持九个宿主适配器。其中六个已有验证过的配置路径;Pi、WorkBuddyGrok 会进入各自当前的支持边界说明。"
},
"homepage.meta.title": {
"message": "AI 编码智能体工作流洞察"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Better Harness 运行在你现有的编码智能体内。宿主差异只进入

## 支持层级

Better Harness 当前声明了八个能力层宿主适配器,其中六个已有验证过的公开
快速开始路径。Pi 与 WorkBuddy 以适配器支持展示,因为它们的安装方式和端到端
Better Harness 当前声明了九个能力层宿主适配器,其中六个已有验证过的公开
快速开始路径。Pi、WorkBuddyGrok 以适配器支持展示,因为它们的安装方式和端到端
证据边界与这六个宿主不同。完整能力层事实源仍是
[规范适配器矩阵](https://github.com/QoderAI/better-harness/blob/main/docs/adapters/README.md)。

Expand All @@ -29,6 +29,7 @@ Better Harness 当前声明了八个能力层宿主适配器,其中六个已
| GitHub Copilot | 已验证快速开始 | 具备分析能力的源码本地宿主 | `.github/plugin/` | 工作区匹配的 Copilot CLI 转录;部分覆盖保持显式标注 | 自包含 HTML + Markdown |
| Pi | 适配器支持 | 具备分析能力的源码本地宿主 | `package.json` 中的 `pi` manifest | 匹配当前工作区的本地 Pi 会话 | 自包含 HTML + Markdown |
| WorkBuddy | 适配器支持 | 具备分析能力的源码本地宿主 | 无;Skill 使用 WorkBuddy 自有路径 | 匹配工作区的 WorkBuddy JSONL 转录 | 自包含 HTML + Markdown |
| Grok | 适配器支持 | 具备分析能力的源码本地宿主 | 无;Skill 使用 Grok 自有路径 | 匹配工作区的 Grok 会话目录(`updates.jsonl`) | 自包含 HTML + Markdown |

`@qoderai/better-harness` npm 包含全部六个插件元数据根目录。生成的 Qoder
运行时 bundle 只包含 Qoder shell。Pi 复用现有 `package.json` 中的安装元数据,
Expand All @@ -40,7 +41,7 @@ Better Harness 当前声明了八个能力层宿主适配器,其中六个已
`canvas.json` 和 `report.canvas.tsx`。
- **Cursor Canvas** —— 使用 `cursor/canvas`、原生 Context Window 证据和
IDE actions 渲染同一份完整报告契约。
- **HTML 可视化** —— 面向 Claude Code/Codex/Qwen/Copilot/Pi/WorkBuddy 的可移植契约,覆盖
- **HTML 可视化** —— 面向 Claude Code/Codex/Qwen/Copilot/Pi/WorkBuddy/Grok 的可移植契约,覆盖
`findings.json`、`report.md` 和自包含的 `report.html`
(见[示例报告](pathname:///demo/better-harness-report/))。
- **纯 Markdown** —— 无视觉版本。
Expand All @@ -59,6 +60,13 @@ WorkBuddy 的已配置资产、工作区匹配的会话证据与可移植 HTML
本仓库不提供 WorkBuddy 安装 Shell、插件 manifest 或 npm 打包的宿主产物;安装
仍通过 WorkBuddy 自有的 `~/.workbuddy/skills` 或 Marketplace 入口完成。

### Grok {#grok}

Grok 的已配置资产、工作区匹配的会话证据与可移植 HTML 路由均已实现。
本仓库不提供 Grok 安装 Shell 或 npm 打包的宿主产物;安装方式是将 Skill 软链到
`~/.grok/skills/better-harness`(或项目 `.grok/skills`)。在观察到完整交互式
报告闭环冒烟验证前,Grok 仍不进入已验证快速开始集合。

## 能力覆盖

各宿主的能力刻意保持差异:没有真实证据源的宿主不会声称具备某项能力,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Cursor 使用源码本地插件,还需要 Git 来克隆本仓库。

:::tip 没有找到你的 Coding Agent?

下方六个标签页是已验证的快速开始路径,项目当前共跟踪八个宿主适配器
下方六个标签页是已验证的快速开始路径,项目当前共跟踪九个宿主适配器
请先[比较全部适配器的支持边界](./hosts/adapter-matrix);如果希望新增或补全
一个集成,再[按照新增宿主贡献流程与 PR 示例操作](./hosts/contributing-new-coding-agent)。
开始重复工作前,也可以先[查看仓库当前的 Pull Requests](https://github.com/QoderAI/better-harness/pulls)。
Expand Down
Loading