Skip to content

Commit ed4219f

Browse files
phodalQoder-AI
andcommitted
docs(hosts): sync public host entrypoints
Align README and Docusaurus Quickstart surfaces with docs/specs/2026-07-30-supported-host-entrypoints.md. Validated with focused entrypoint tests, doc-link graph, and git diff --check. Co-authored-by: QoderAI <qoder_ai@qoder.com>
1 parent 3004766 commit ed4219f

19 files changed

Lines changed: 756 additions & 79 deletions

README.md

Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,25 @@
3131
<a href="docs/community.md">Contribute</a>
3232
</p>
3333

34-
## See it in action
34+
## Quick start
35+
36+
Review your coding workflow with: [Claude Code](#claude-code), [Codex Desktop](#codex-desktop), [Codex CLI](#codex-cli), [Qoder Desktop/CLI](#qoder), [Cursor](#cursor), [Qwen Code](#qwen-code), or [GitHub Copilot CLI](#github-copilot).
3537

36-
Ask `/better-harness` to review the current task and its surrounding project
37-
Harness, then generate a durable report:
38+
Once installed, ask Better Harness to generate the host's durable report:
3839

3940
```text
4041
/better-harness review this project's AI coding workflow and generate a report
4142
```
4243

44+
Better Harness scopes behavior claims to relevant Task Episodes and the
45+
surrounding project mechanisms. Qoder produces a Canvas report; Claude Code,
46+
Codex, Cursor, Qwen Code, and GitHub Copilot produce self-contained HTML with
47+
paired Markdown. Missing or partial evidence remains explicit. See the
48+
[Host Adapter Matrix](docs/adapters/README.md) for current coverage and output
49+
differences.
50+
51+
## See it in action
52+
4353
The report keeps missing evidence explicit and turns supported gaps into
4454
prioritized findings with an impact, expected output, scoped repair, and
4555
acceptance checks.
@@ -141,32 +151,6 @@ The architecture keeps the three evidence domains independent until unified
141151
analysis by the lead agent. Every result retains a visible evidence source,
142152
owner, and validation route.
143153

144-
## Quick start
145-
146-
Pick your coding agent — you can be looking at your first report in minutes:
147-
148-
| Coding agent | Setup |
149-
| --- | --- |
150-
| **Claude Code** | Add the repository marketplace, install `better-harness@better-harness`, start a new session, then use the report prompt below. |
151-
| **Codex Desktop** | Add the repository under **Settings > Plugins > + Add > From Marketplace**, install Better Harness, start a new task, then invoke `@better-harness`. |
152-
| **Codex CLI** | Add the Git marketplace, run `codex plugin add better-harness@better-harness`, then invoke `$better-harness:better-harness`. |
153-
| **Qoder Desktop / CLI** | Nothing to install when Qoder Desktop is installed — Better Harness is built in and available to both. Open your repository and use the report prompt below. |
154-
| **GitHub Copilot CLI** | Add the repository marketplace, install `better-harness@better-harness`, start a new session, then use the report prompt below. |
155-
| **Cursor** | Load the plugin from source — see [Installation](#installation). |
156-
157-
Once installed, ask Better Harness to generate the host's durable report:
158-
159-
```text
160-
/better-harness review this project's AI coding workflow and generate a report
161-
```
162-
163-
Better Harness scopes behavior claims to relevant Task Episodes and the
164-
surrounding project mechanisms. Qoder produces a Canvas report; Claude Code,
165-
Codex, Cursor, Qwen Code, and GitHub Copilot produce self-contained HTML with
166-
paired Markdown. Missing or partial evidence remains explicit. See the
167-
[Host Adapter Matrix](docs/adapters/README.md) for current coverage and output
168-
differences.
169-
170154
## Installation
171155

172156
Installation differs by coding agent. Install Better Harness separately for
@@ -209,6 +193,8 @@ stays explicit rather than being inferred.
209193

210194
### Codex
211195

196+
<a id="codex-desktop"></a>
197+
212198
#### Codex Desktop
213199

214200
1. Open **Settings > Plugins**.
@@ -228,6 +214,8 @@ Use `https://github.com/QoderAI/better-harness.git` with Git ref `main`.
228214

229215
![Codex Add plugin marketplace dialog with repository, Git ref, and optional sparse paths](assets/install/codex-add-marketplace.jpg)
230216

217+
<a id="codex-cli"></a>
218+
231219
#### Codex CLI
232220

233221
Add the repository source:
@@ -336,6 +324,25 @@ transcripts under `~/.copilot/session-state/`. Copilot records no per-response
336324
token usage, and VS Code Copilot Chat has no supported durable transcript; both
337325
remain explicit evidence boundaries.
338326

327+
### Qwen Code
328+
329+
Install Better Harness as a Qwen Code extension:
330+
331+
```bash
332+
qwen extensions install QoderAI/better-harness
333+
```
334+
335+
Start a new Qwen Code session in the repository you want to review and run the
336+
report prompt:
337+
338+
```text
339+
/better-harness review this project's AI coding workflow and generate a report
340+
```
341+
342+
Qwen Code produces a self-contained `report.html` with paired `report.md` and
343+
`findings.json`. Session evidence coverage depends on Qwen Code's available
344+
transcript paths; missing or partial evidence remains explicit.
345+
339346
## Develop and package from source
340347

341348
Development requires Node.js `>=22.20.0 <25.0.0` and npm

README.zh-CN.md

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,27 @@
2929
<a href="docs/community.md">参与贡献</a>
3030
</p>
3131

32-
<a id="see-it-in-action"></a>
32+
<a id="quick-start"></a>
3333

34-
## 看看实际效果
34+
## 快速开始
35+
36+
用以下 Coding Agent 审查你的工作流:[Claude Code](#claude-code)[Codex Desktop](#codex-desktop)[Codex CLI](#codex-cli)[Qoder Desktop/CLI](#qoder)[Cursor](#cursor)[Qwen Code](#qwen-code)[GitHub Copilot CLI](#github-copilot)
3537

36-
`/better-harness` 审查当前任务及其所在项目的 Harness,并生成一份可留存的报告
38+
安装完成后,让 Better Harness 生成当前宿主支持的持久化报告
3739

3840
```text
3941
/better-harness 审查此项目的 AI 编码工作流并生成报告
4042
```
4143

44+
Better Harness 会将行为断言限定在相关的任务过程片段(Task Episode)及其周边项目机制内。
45+
Qoder 生成 Canvas 报告;Claude Code、Codex、Cursor、Qwen Code 和 GitHub Copilot 生成自包含的 HTML 报告及配套 Markdown。
46+
缺失或不完整的证据会被明确标注。有关当前覆盖范围和输出差异,请参阅
47+
[宿主适配器矩阵](docs/adapters/README.md)
48+
49+
<a id="see-it-in-action"></a>
50+
51+
## 看看实际效果
52+
4253
报告会明确标注证据缺口,并将有证据支撑的问题整理成按优先级排列的发现;
4354
每项发现都包含影响、预期输出、范围明确的修复方案与验收检查。
4455

@@ -133,32 +144,6 @@ Better Harness 开放了三个相互关联的层次,而不只是一个斜杠
133144
该架构让三个证据域保持独立,直到主智能体进行统一分析。
134145
每个结果都会保留可见的证据来源、责任归属和验证路径。
135146

136-
<a id="quick-start"></a>
137-
138-
## 快速开始
139-
140-
选择你的编码智能体——几分钟内即可看到第一份报告:
141-
142-
| 编码智能体 | 设置方式 |
143-
| --- | --- |
144-
| **Claude Code** | 添加本仓库 Marketplace,安装 `better-harness@better-harness`,启动新会话,然后使用下方的报告提示词。 |
145-
| **Codex Desktop** |**Settings > Plugins > + Add > From Marketplace** 中添加本仓库,安装 Better Harness,启动新任务,然后调用 `@better-harness`|
146-
| **Codex CLI** | 添加 Git Marketplace,运行 `codex plugin add better-harness@better-harness`,然后调用 `$better-harness:better-harness`|
147-
| **Qoder Desktop / CLI** | 安装 Qoder Desktop 后无需额外安装——Better Harness 已内置,并可在桌面端和 CLI 中使用。打开仓库并使用下方的报告提示词。 |
148-
| **GitHub Copilot CLI** | 添加本仓库 Marketplace,安装 `better-harness@better-harness`,启动新会话,然后使用下方的报告提示词。 |
149-
| **Cursor** | 从源码加载插件——参见[安装](#installation)|
150-
151-
安装完成后,让 Better Harness 生成当前宿主支持的持久化报告:
152-
153-
```text
154-
/better-harness 审查此项目的 AI 编码工作流并生成报告
155-
```
156-
157-
Better Harness 会将行为断言限定在相关的任务过程片段(Task Episode)及其周边项目机制内。
158-
Qoder 生成 Canvas 报告;Claude Code、Codex、Cursor、Qwen Code 和 GitHub Copilot 生成自包含的 HTML 报告及配套 Markdown。
159-
缺失或不完整的证据会被明确标注。有关当前覆盖范围和输出差异,请参阅
160-
[宿主适配器矩阵](docs/adapters/README.md)
161-
162147
<a id="installation"></a>
163148

164149
## 安装
@@ -202,6 +187,8 @@ Claude Code 默认会在仓库的 `.claude/better-harness` 报告根目录下生
202187

203188
### Codex
204189

190+
<a id="codex-desktop"></a>
191+
205192
#### Codex Desktop
206193

207194
1. 打开 **Settings > Plugins**
@@ -218,6 +205,8 @@ Claude Code 默认会在仓库的 `.claude/better-harness` 报告根目录下生
218205

219206
![Codex 添加插件 Marketplace 的对话框,包含仓库、Git ref 和可选的 sparse paths](assets/install/codex-add-marketplace.jpg)
220207

208+
<a id="codex-cli"></a>
209+
221210
#### Codex CLI
222211

223212
添加仓库源:
@@ -319,6 +308,23 @@ Copilot 会话证据来自 `~/.copilot/session-state/` 下与工作区匹配的
319308
Copilot 不记录逐次响应的 token 用量,VS Code Copilot Chat 也没有受支持的持久化会话记录;
320309
两者均作为明确的证据边界保留。
321310

311+
### Qwen Code
312+
313+
将 Better Harness 安装为 Qwen Code 扩展:
314+
315+
```bash
316+
qwen extensions install QoderAI/better-harness
317+
```
318+
319+
在要审查的仓库中启动新的 Qwen Code 会话,然后运行报告提示词:
320+
321+
```text
322+
/better-harness 审查此项目的 AI 编码工作流并生成报告
323+
```
324+
325+
Qwen Code 产出自包含的 `report.html`,并配套 `report.md``findings.json`
326+
会话证据覆盖范围取决于 Qwen Code 可用的会话记录路径;缺失或不完整的证据保持显式标注。
327+
322328
<a id="develop-and-package-from-source"></a>
323329

324330
## 从源码开发和打包

docs/adapters/contributing-new-coding-agent.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,21 @@ A shell does not prove configured-asset or session support. A session parser doe
3636
not prove the Skill is natively discoverable. Do not register one slice merely
3737
to make another slice appear complete.
3838

39+
### Capability levels
40+
41+
Not every host lands with full end-to-end support. Be explicit about which of
42+
these levels the contribution reaches, and do not promote a host to the next
43+
level until the corresponding evidence exists:
44+
45+
| Level | What it means | Minimum evidence | Public visibility |
46+
| --- | --- | --- | --- |
47+
| Partial adapter | Some slices work (often shell, configured assets, or sessions) while others are partial or unavailable. | Spec names claimed, partial, and unavailable slices; provider/session tests pass for the claimed subset. | Matrix and docs list the host with explicit limitations; do not add to the public Quickstart list. |
48+
| Verified install/discovery | The native install, link, or discovery command is smoke-tested and the Skill loads. | Native CLI smoke in an isolated home/config when possible; fallback is a pinned official doc reference plus a recorded evidence boundary. | README Installation section may list the host; still not Quickstart unless the report loop is validated. |
49+
| Public Quickstart-ready | Full report loop works: install/discovery, configured assets, session evidence (when claimed), output routing, and a validated report render. | End-to-end report generation on a real or representative repository; tests cover the public-entrypoint set. | Host appears in the README Quickstart list, Docusaurus home-page cards, and installation tabs. |
50+
51+
A host can be merged at the partial or verified level and later promoted to
52+
public Quickstart-ready once the report loop evidence is complete.
53+
3954
## 2. Verify the Native Host Contract
4055

4156
Do not derive a new host contract by renaming another adapter. Record the host
@@ -119,7 +134,7 @@ sessions, reports, and packaging have different owners. Search for the existing
119134
host set before editing:
120135

121136
```bash
122-
rg -n "qoder|codex|claude|cursor|qwen" scripts test references templates docs package.json
137+
rg -n "qoder|codex|claude|cursor|qwen|copilot" scripts test references templates docs package.json
123138
```
124139

125140
Use the results as an inventory, not a replacement template. Typical registration

docs/docs/concepts/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ progressive detail you load when a task needs it.
6666
| --- | --- |
6767
| Skill | A repeatable agent workflow defined by `SKILL.md` frontmatter plus a concise workflow. |
6868
| Host adapter | Per-host discovery and evidence-shape glue; keeps the engine host-neutral. |
69-
| Host shell | Thin host metadata (`.claude-plugin/`, `.qoder-plugin/`, `.cursor-plugin/`, `.codex-plugin/`) that exposes canonical behavior without owning product logic. |
69+
| Host shell | Thin host metadata (`.claude-plugin/`, `.qoder-plugin/`, `.cursor-plugin/`, `.codex-plugin/`, `.github/plugin/`, `qwen-extension.json`, or a future lifecycle shell) that exposes canonical behavior without owning product logic; the public npm package ships all six current metadata roots, while the Qoder runtime bundle includes only `.qoder-plugin/`. |
7070
| Canonical owner | The single directory that owns a behavior's product judgment; host shells and mirrors point back to it. |
7171

7272
The full glossary with owner links lives in

docs/docs/hosts/adapter-matrix.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,19 @@ host-neutral.
1919
| Claude Code | Analysis-capable source-local host | `.claude-plugin/` | Workspace-matching local Claude transcripts when present | Self-contained HTML + Markdown |
2020
| Codex | Analysis-capable source-local host | `.codex-plugin/` | Codex sessions | Self-contained HTML + Markdown |
2121
| Cursor | Analysis-capable source-local host | `.cursor-plugin/` | Workspace-matched transcripts, metadata, and audit logs; partial coverage stays explicit | Self-contained HTML + Markdown |
22+
| Qwen Code | Analysis-capable source-local host | `qwen-extension.json` | Workspace-matching local Qwen transcripts when present | Self-contained HTML + Markdown |
23+
| GitHub Copilot | Analysis-capable source-local host | `.github/plugin/` | Workspace-matched Copilot CLI transcripts; partial coverage stays explicit | Self-contained HTML + Markdown |
2224

23-
The `@qoderai/better-harness` npm package includes all four plugin metadata
25+
The `@qoderai/better-harness` npm package includes all six plugin metadata
2426
roots. The generated Qoder runtime bundle includes only the Qoder shell;
2527
non-Qoder generated host artifacts remain source-local.
2628

2729
## Output modes
2830

2931
- **Qoder Canvas** — renderer-owned `findings.json`, Canvas-only
3032
`canvas.json`, and `report.canvas.tsx`.
31-
- **HTML visual** — portable Claude Code/Codex/Cursor contract covering
32-
`findings.json`, `report.md`, and a self-contained `report.html`
33+
- **HTML visual** — portable Claude Code/Codex/Cursor/Qwen/Copilot contract
34+
covering `findings.json`, `report.md`, and a self-contained `report.html`
3335
(see the [live demo](pathname:///demo/better-harness-report/)).
3436
- **Markdown-only** — no visual companion.
3537

docs/docs/installation.mdx

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,55 @@ cursor-agent --plugin-dir /path/to/better-harness
148148
Cursor session evidence is supported through workspace-matched transcripts,
149149
metadata, and audit logs. Partial or unavailable coverage remains explicit.
150150

151+
</TabItem>
152+
<TabItem value="qwen-code" label="Qwen Code">
153+
154+
## Qwen Code {#qwen-code}
155+
156+
Install Better Harness as a Qwen Code extension:
157+
158+
```bash
159+
qwen extensions install QoderAI/better-harness
160+
```
161+
162+
Start a new Qwen Code session in the repository you want to review and run the
163+
report prompt:
164+
165+
```text
166+
/better-harness review this project's AI coding workflow and generate a report
167+
```
168+
169+
Qwen Code produces a self-contained `report.html` with paired `report.md` and
170+
`findings.json`. Session evidence coverage depends on Qwen Code's available
171+
transcript paths; missing or partial evidence remains explicit.
172+
173+
</TabItem>
174+
<TabItem value="github-copilot" label="GitHub Copilot">
175+
176+
## GitHub Copilot {#github-copilot}
177+
178+
Register this repository as a Copilot plugin marketplace, then install Better
179+
Harness:
180+
181+
```bash
182+
copilot plugin marketplace add QoderAI/better-harness
183+
copilot plugin install better-harness@better-harness
184+
```
185+
186+
Verify that the Skill loaded:
187+
188+
```bash
189+
copilot plugin list
190+
```
191+
192+
Prefer marketplace installs. Direct repository, URL, and local-path installs are
193+
deprecated in Copilot CLI.
194+
195+
Copilot session evidence is supported through workspace-matched Copilot CLI
196+
transcripts under `~/.copilot/session-state/`. Copilot records no per-response
197+
token usage, and VS Code Copilot Chat has no supported durable transcript; both
198+
remain explicit evidence boundaries.
199+
151200
</TabItem>
152201
</Tabs>
153202

docs/docs/reference/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ available after the agent acts:
4444
| Project evidence | `better-harness core-change-watch` | Project, history, core-path, and diff signals |
4545
| Change confidence | `hooks/git-scripts/blast-radius` | Symbol-graph blast radius of a change |
4646
| Dependency governance | `better-harness dependency-governance` | Update automation, audit, stale-dep signals |
47-
| Session evidence | `better-harness session-analysis` | Normalize Qoder, Codex, Claude, or Cursor session behavior |
47+
| Session evidence | `better-harness session-analysis` | Normalize Qoder, Codex, Claude, Cursor, Qwen, or Copilot session behavior |
4848
| Agent assets | `better-harness coding-agent-practices inventory` | Inventory configured agent surfaces |
4949
| Guardrails | `hooks/`, `scripts/agent-guardrails` | Secret scanning and lifecycle checks |
5050

docs/docs/your-first-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ you want to review, start a new session, and run:
1515

1616
Better Harness scopes behavior claims to relevant Task Episodes and the
1717
surrounding project mechanisms. Qoder produces a Canvas report; Claude Code,
18-
Codex, and Cursor produce self-contained HTML with paired Markdown. Missing or
19-
partial evidence remains explicit.
18+
Codex, Cursor, Qwen Code, and GitHub Copilot produce self-contained HTML with
19+
paired Markdown. Missing or partial evidence remains explicit.
2020

2121
See the [live demo report](pathname:///demo/better-harness-report/) for
2222
what the HTML output looks like.

docs/i18n/zh-Hans/code.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@
4141
"homepage.hosts.cursor.setup": {
4242
"message": "使用 --plugin-dir 加载源码本地插件。"
4343
},
44+
"homepage.hosts.qwenCode.setup": {
45+
"message": "作为 Qwen Code 扩展安装。"
46+
},
47+
"homepage.hosts.githubCopilot.setup": {
48+
"message": "添加 Marketplace 并安装插件。"
49+
},
4450
"homepage.hero.tagline": {
4551
"message": "看清你的 AI 编码工作流——并一步一步把它变好。"
4652
},

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ sidebar_position: 3
6363
| --- | --- |
6464
| Skill |`SKILL.md` frontmatter 加简洁工作流定义的可重复智能体工作流。 |
6565
| 宿主适配层 | 按宿主的发现与证据形态胶水层;保持引擎与宿主无关。 |
66-
| 宿主 shell | 轻量宿主元数据(`.claude-plugin/``.qoder-plugin/``.cursor-plugin/``.codex-plugin/`),暴露规范行为但不拥有产品逻辑。 |
66+
| 宿主 shell | 轻量宿主元数据(`.claude-plugin/``.qoder-plugin/``.cursor-plugin/``.codex-plugin/``.github/plugin/``qwen-extension.json` 或未来的生命周期 shell),暴露规范行为但不拥有产品逻辑;公共 npm 包包含当前六个元数据根目录,而 Qoder 运行时 bundle 只包含 `.qoder-plugin/`|
6767
| 规范负责目录 | 唯一拥有某行为产品判断的目录;宿主 shell 和镜像都指回它。 |
6868

6969
带负责方链接的完整术语表见

0 commit comments

Comments
 (0)