Skip to content

Commit 4d14212

Browse files
committed
docs(codex): correct Better Harness skill invocation
Document the host-specific Better Harness invocation for Codex Desktop and Codex CLI in both README languages. Keep slash-command examples for other hosts unchanged and add regression coverage for the Codex sections. Validated with node --test test/session-analysis.test.mjs test/session-analysis-core-facts.test.mjs test/better-harness-evidence-bundle.test.mjs test/better-harness-skill.test.mjs.
1 parent 6afe786 commit 4d14212

3 files changed

Lines changed: 34 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ Pick your coding agent — you can be looking at your first report in minutes:
146146
| Coding agent | Setup |
147147
| --- | --- |
148148
| **Claude Code** | Add the repository marketplace, install `better-harness@better-harness`, start a new session, then use the report prompt below. |
149-
| **Codex Desktop** | Add the repository under **Settings > Plugins > + Add > From Marketplace**, install Better Harness, start a new task, then use the report prompt below. |
150-
| **Codex CLI** | Add the Git marketplace, then run `codex plugin add better-harness@better-harness`. |
149+
| **Codex Desktop** | Add the repository under **Settings > Plugins > + Add > From Marketplace**, install Better Harness, start a new task, then invoke `@better-harness`. |
150+
| **Codex CLI** | Add the Git marketplace, run `codex plugin add better-harness@better-harness`, then invoke `$better-harness:better-harness`. |
151151
| **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. |
152152
| **Cursor** | Load the plugin from source — see [Installation](#installation). |
153153

@@ -214,8 +214,12 @@ stays explicit rather than being inferred.
214214
empty for this single-plugin repository.
215215
4. Select **Add marketplace**, then install **Better Harness** from the new
216216
marketplace.
217-
5. Start a new task in the repository you want to review and use the report
218-
prompt from [Quick start](#quick-start).
217+
5. Start a new task in the repository you want to review and run the report
218+
prompt:
219+
220+
```text
221+
@better-harness review this project's AI coding workflow and generate a report
222+
```
219223

220224
Use `https://github.com/QoderAI/better-harness.git` with Git ref `main`.
221225

@@ -242,7 +246,7 @@ Start a new Codex task in the repository you want to review and run the report
242246
prompt:
243247

244248
```text
245-
/better-harness review this project's AI coding workflow and generate a report
249+
$better-harness:better-harness review this project's AI coding workflow and generate a report
246250
```
247251

248252
Use the repository URL with `marketplace add`, not a raw `marketplace.json`

README.zh-CN.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ Better Harness 开放了三个相互关联的层次,而不只是一个斜杠
142142
| 编码智能体 | 设置方式 |
143143
| --- | --- |
144144
| **Claude Code** | 添加本仓库 Marketplace,安装 `better-harness@better-harness`,启动新会话,然后使用下方的报告提示词。 |
145-
| **Codex Desktop** |**Settings > Plugins > + Add > From Marketplace** 中添加本仓库,安装 Better Harness,启动新任务,然后使用下方的报告提示词|
146-
| **Codex CLI** | 添加 Git Marketplace,然后运行 `codex plugin add 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`|
147147
| **Qoder Desktop / CLI** | 安装 Qoder Desktop 后无需额外安装——Better Harness 已内置,并可在桌面端和 CLI 中使用。打开仓库并使用下方的报告提示词。 |
148148
| **Cursor** | 从源码加载插件——参见[安装](#installation)|
149149

@@ -207,7 +207,11 @@ Claude Code 默认会在仓库的 `.claude/better-harness` 报告根目录下生
207207
2. 选择 **+ Add > From Marketplace**
208208
3. 输入 Git 仓库 URL,设置 Git ref;对于这个单插件仓库,**Sparse paths** 留空。
209209
4. 选择 **Add marketplace**,然后从新 Marketplace 中安装 **Better Harness**
210-
5. 在需要审查的仓库中启动新任务,并使用[快速开始](#quick-start)中的报告提示词。
210+
5. 在需要审查的仓库中启动新任务,并运行报告提示词:
211+
212+
```text
213+
@better-harness 审查此项目的 AI 编码工作流并生成报告
214+
```
211215

212216
仓库 URL 使用 `https://github.com/QoderAI/better-harness.git`,Git ref 使用 `main`
213217

@@ -233,7 +237,7 @@ codex plugin add better-harness@better-harness
233237
在需要审查的仓库中启动新的 Codex 任务,并运行报告提示词:
234238

235239
```text
236-
/better-harness 审查此项目的 AI 编码工作流并生成报告
240+
$better-harness:better-harness 审查此项目的 AI 编码工作流并生成报告
237241
```
238242

239243
使用 `marketplace add` 时应传入仓库 URL,而不是原始 `marketplace.json` URL。

test/better-harness-skill.test.mjs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,23 @@ test("non-Qoder providers default to validated durable HTML with an explicit inl
8686
assert.match(readme, /\.claude\/better-harness/);
8787
});
8888

89+
test("Codex README examples use host-specific skill invocation syntax", () => {
90+
for (const readmePath of ["README.md", "README.zh-CN.md"]) {
91+
const readme = read(readmePath);
92+
const desktopQuickStart = readme.match(/^\| \*\*Codex Desktop\*\* \|.*$/mu)?.[0] ?? "";
93+
const cliQuickStart = readme.match(/^\| \*\*Codex CLI\*\* \|.*$/mu)?.[0] ?? "";
94+
const desktop = readme.match(/#### Codex Desktop\n([\s\S]*?)\n#### Codex CLI/u)?.[1] ?? "";
95+
const cli = readme.match(/#### Codex CLI\n([\s\S]*?)\n### Qoder/u)?.[1] ?? "";
96+
97+
assert.match(desktopQuickStart, /`@better-harness`/u);
98+
assert.match(cliQuickStart, /`\$better-harness:better-harness`/u);
99+
assert.match(desktop, /^@better-harness(?:[ \t]|$)/mu);
100+
assert.match(cli, /^\$better-harness:better-harness(?:[ \t]|$)/mu);
101+
assert.doesNotMatch(desktop, /^[ \t]*\/better-harness(?:[ \t]|$)/mu);
102+
assert.doesNotMatch(cli, /^[ \t]*\/better-harness(?:[ \t]|$)/mu);
103+
}
104+
});
105+
89106
test("Step 1 establishes one provider-labelled evidence bundle", () => {
90107
const skill = read("skills/better-harness/SKILL.md");
91108

0 commit comments

Comments
 (0)