Skip to content

Commit 4afe017

Browse files
author
chenbo
committed
Align docs and config with OpenCode-first branding
1 parent 0215c5a commit 4afe017

23 files changed

Lines changed: 73 additions & 65 deletions

README.en.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ The README main path intentionally recommends only `opencode-plusplus`. Batch Ha
9191

9292
## What It Solves
9393

94-
- Agents guess entry files and modules because repository context is incomplete.
95-
- Agents over-edit generated files, lockfiles, CI, migrations, or unrelated modules.
96-
- Agents hallucinate APIs, commands, config keys, environment variables, or project conventions.
97-
- Agents claim tests passed without reliable exit-code, timestamp, or working-tree-hash evidence.
98-
- Agents make changes whose downstream impact is invisible during review.
99-
- Agents reintroduce historical bugs or keep repairing without a clear stop condition.
94+
- OpenCode guesses entry files and modules because repository context is incomplete.
95+
- OpenCode over-edits generated files, lockfiles, CI, migrations, or unrelated modules.
96+
- OpenCode hallucinates APIs, commands, config keys, environment variables, or project conventions.
97+
- OpenCode claims tests passed without reliable exit-code, timestamp, or working-tree-hash evidence.
98+
- OpenCode makes changes whose downstream impact is invisible during review.
99+
- OpenCode reintroduces historical bugs or keeps repairing without a clear stop condition.
100100

101101
## Current Maturity
102102

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,12 @@ opencode-plusplus --pure # 纯 OpenCode,不启用 OpenCode++
9090

9191
## 解决什么问题
9292

93-
- Agent 不知道该读哪些文件,靠猜入口和模块。
94-
- Agent 修改范围失控,误改 generated、lockfile、CI、migration 或无关模块。
95-
- Agent 生成不存在的 API、命令、配置、环境变量或项目约定。
96-
- Agent 声称测试通过,但没有可信的 exit code / timestamp / working tree hash 证据。
97-
- Agent 改完影响范围不可见,review 风险难判断。
98-
- Agent 重复引入历史 bug,repair loop 不知道何时停止。
93+
- OpenCode 不知道该读哪些文件,靠猜入口和模块。
94+
- OpenCode 修改范围失控,误改 generated、lockfile、CI、migration 或无关模块。
95+
- OpenCode 生成不存在的 API、命令、配置、环境变量或项目约定。
96+
- OpenCode 声称测试通过,但没有可信的 exit code / timestamp / working tree hash 证据。
97+
- OpenCode 改完影响范围不可见,review 风险难判断。
98+
- OpenCode 重复引入历史 bug,repair loop 不知道何时停止。
9999

100100
## 当前能力成熟度
101101

docs/agents-md.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ If those headings are not found, the tool falls back to moving the whole legacy
6060
You do not have to run the CLI by hand. You can ask a coding agent to use [whut09/OpenCode-plusplus](https://github.com/whut09/opencode-plusplus) against another repository:
6161

6262
```txt
63-
Use https://github.com/whut09/opencode-plusplus to generate AGENTS.md and a .agent-context package for the xxx project. Inspect the target repository first, then install or clone the tool if needed. Force LLM summaries: create or update opencode-plusplus.local.yml in the target repo, do not commit that file, and prefer the model API configuration available in the current AI tool environment or the key/baseUrl/model I provide; if configuration is missing, ask me first. Then run opencode-plusplus build <target-repo> --target codex --llm, run opencode-plusplus validate <target-repo>, and summarize the generated files plus whether LLM summary mode succeeded.
63+
Use https://github.com/whut09/opencode-plusplus to generate AGENTS.md and a .agent-context package for the xxx project. Inspect the target repository first, then install or clone the tool if needed. Force LLM summaries: create or update opencode-plusplus.local.yml in the target repo, do not commit that file, and prefer the model API configuration available in the current AI tool environment or the key/baseUrl/model I provide; if configuration is missing, ask me first. Then run opencode-plusplus build <target-repo> --target opencode --llm, run opencode-plusplus validate <target-repo>, and summarize the generated files plus whether LLM summary mode succeeded.
6464
```
6565

6666
Replace `xxx project` with a local path, GitHub repository, or workspace name. This works especially well in Codex because Codex can run commands in the workspace and then read the generated `AGENTS.md` before making later edits.
@@ -78,7 +78,7 @@ Codex supports `AGENTS.md` directly. According to the Codex documentation, Codex
7878
Recommended usage:
7979

8080
```bash
81-
opencode-plusplus build . --target codex
81+
opencode-plusplus build . --target opencode
8282
codex "Summarize the current repository instructions."
8383
```
8484

docs/agents-md.zh-CN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Generated context is split into L0-L3 so agents do not load the full `.agent-con
6363
你不一定要手动运行 CLI,也可以直接让编程 Agent 使用 [whut09/OpenCode-plusplus](https://github.com/whut09/opencode-plusplus) 去处理另一个仓库:
6464

6565
```txt
66-
使用 https://github.com/whut09/opencode-plusplus 对 xxx 项目生成 AGENTS.md 和 .agent-context 上下文包。请先检查目标仓库结构,再按需安装或克隆该工具。请强制启用 LLM 摘要:在目标仓库创建或更新 opencode-plusplus.local.yml,不要提交该文件,优先使用当前 AI 工具环境里可用的模型 API 配置或我提供的 key/baseUrl/model;如果缺少配置,请先问我。然后运行 opencode-plusplus build <目标仓库> --target codex --llm,再运行 opencode-plusplus validate <目标仓库>,最后说明生成了哪些文件和 LLM 摘要模式是否成功。
66+
使用 https://github.com/whut09/opencode-plusplus 对 xxx 项目生成 AGENTS.md 和 .agent-context 上下文包。请先检查目标仓库结构,再按需安装或克隆该工具。请强制启用 LLM 摘要:在目标仓库创建或更新 opencode-plusplus.local.yml,不要提交该文件,优先使用当前 AI 工具环境里可用的模型 API 配置或我提供的 key/baseUrl/model;如果缺少配置,请先问我。然后运行 opencode-plusplus build <目标仓库> --target opencode --llm,再运行 opencode-plusplus validate <目标仓库>,最后说明生成了哪些文件和 LLM 摘要模式是否成功。
6767
```
6868

6969
把 `xxx 项目` 替换成本地路径、GitHub 仓库或当前工作区名称即可。这种方式在 Codex 里尤其自然,因为 Codex 可以在工作区运行命令,并在后续修改代码前读取生成的 `AGENTS.md`。
@@ -81,7 +81,7 @@ Codex 原生支持 `AGENTS.md`。根据 Codex 文档,Codex 会在开始工作
8181
推荐用法:
8282

8383
```bash
84-
opencode-plusplus build . --target codex
84+
opencode-plusplus build . --target opencode
8585
codex "Summarize the current repository instructions."
8686
```
8787

docs/concepts/loop-engineering.zh-CN.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ direct lexical hits
9292
tests.md
9393
verify.md
9494
impact.md
95+
prompt.opencode.md
9596
prompt.codex.md
9697
prompt.claude.md
9798
prompt.cursor.md

docs/getting-started.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Read the generated run directory:
9898
tests.md
9999
impact.md
100100
verify.md
101-
prompt.codex.md
101+
prompt.opencode.md
102102
```
103103

104104
## Advanced: Verify After Edits
@@ -127,8 +127,6 @@ opencode-plusplus oc repair
127127
.opencode/commands/opencode-plusplus.md
128128
.opencode/commands/opencode-plusplus-verify.md
129129
.opencode/agents/opencode-plusplus.md
130-
.opencode/commands/opencode-plusplus.md
131-
.opencode/commands/opencode-plusplus-verify.md
132130
```
133131

134132
Use `orchestrate --executor-command` when you need a custom executor command.

docs/integrations/opencode-sidecar.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,6 @@ The generated OpenCode plugin listens for:
7575
.opencode/commands/opencode-plusplus.md
7676
.opencode/commands/opencode-plusplus-verify.md
7777
.opencode/agents/opencode-plusplus.md
78-
.opencode/commands/opencode-plusplus.md
79-
.opencode/commands/opencode-plusplus-verify.md
8078
.agent-context/sidecar/latest.json
8179
.agent-context/sidecar/latest.md
8280
.agent-context/sidecar/policy.md

docs/reference/config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Do not commit `opencode-plusplus.local.yml`.
1717
## Example
1818

1919
```yaml
20-
target: codex
20+
target: opencode
2121
tokenBudget: 100000
2222

2323
include:
@@ -42,8 +42,8 @@ llm:
4242
model: "xx"
4343

4444
rag:
45-
enabled: true
46-
chunkTokenLimit: 1200
45+
provider: lightrag
46+
chunkTokenLimit: 900
4747
```
4848
4949
## LLM Credentials

opencode-plusplus.config.example.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
target: codex
1+
target: opencode
22
tokenBudget: 60000
33

44
include:

src/benchmarks/agent-benchmark.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ async function promptForMode(repo: string, task: BenchmarkTaskDefinition, mode:
438438
`Task: ${task.task}`,
439439
"",
440440
`Use the task context pack at ${path.relative(repo, run.dir).replaceAll("\\", "/")}.`,
441-
"Read plan.md, edit-boundary.md, pack.md, tests.md, impact.md, and prompt.codex.md before editing.",
441+
"Read plan.md, edit-boundary.md, pack.md, tests.md, impact.md, and prompt.opencode.md before editing.",
442442
"Keep changes inside the boundary and run required verification."
443443
].join("\n");
444444
}

0 commit comments

Comments
 (0)