docs: improve zh-cn and zh-tw documentation translations (#13942)

This commit is contained in:
chenmi
2026-02-17 06:06:39 -06:00
committed by GitHub
parent 8d0a303af4
commit 4fd3141ab5
68 changed files with 4624 additions and 4518 deletions
+40 -40
View File
@@ -1,29 +1,29 @@
---
title: 规则
description: 设置opencode的自定义指令。
description: 为 opencode 设置自定义指令。
---
您可以通过 `AGENTS.md` 文件创建 opencode 的自定义指令。这和 Cursor 的规则类似。它包含将包含在 LLM 上下文中的说明,方便您的特定项目自定义其行为。
您可以通过创建 `AGENTS.md` 文件来为 opencode 提供自定义指令。这类似于 Cursor 的规则功能。该文件包含的指令会被纳入 LLM 的上下文中,以便针对您的特定项目自定义其行为。
---
## 初始化
要创建新的`AGENTS.md`文件,您可以在opencode中运行`/init`命令。
要创建新的 `AGENTS.md` 文件,您可以在 opencode 中运行 `/init` 命令。
:::tip
您应该将项目的 `AGENTS.md` 文件提交到 Git。
:::
这将扫描您的项目及其所有内容,以了解该项目的内容并生成一个 `AGENTS.md` 文件。这有助于更好地打开代码导航项目。
该命令会扫描您的项目及其所有内容,了解项目的用途,并据此生成一个 `AGENTS.md` 文件。这有助于 opencode 更好地导航您的项目。
如果您已有现有的 `AGENTS.md` 文件,将尝试添加到其中。
如果您已有 `AGENTS.md` 文件,该命令会尝试在其基础上进行补充。
---
## 例子
## 示例
您也可以手动创建此文件。以下是您可以导入 `AGENTS.md` 文件中的一些内容的示例。
您也可以手动创建此文件。以下是一些可以放入 `AGENTS.md` 文件中的内容示例。
```markdown title="AGENTS.md"
# SST v3 Monorepo Project
@@ -48,33 +48,33 @@ This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for
- Import shared modules using workspace names: `@my-app/core/example`
```
我们在此处添加特定于项目的说明,这将在您的团队中共享。
我们在这里添加了项目特定的指令,这些指令会在您的团队中共享。
---
## 类型
opencode 还支持从多个位置读取 `AGENTS.md` 文件。这有不同的目的。
opencode 还支持从多个位置读取 `AGENTS.md` 文件,不同的位置有不同的用途。
### 项目
### 项目级
将 `AGENTS.md` 放置在项目根目录中以获取特定于项目的规则。这些仅适用于您在此目录或子目录中工作时。
在项目根目录放置一个 `AGENTS.md` 文件,用于定义项目特定的规则。这些规则仅在您在该目录或其子目录中工作时生效。
### 全局
### 全局级
您还可以在 `~/.config/opencode/AGENTS.md` 文件中包含全局规则。这适用于所有opencode会话。
您还可以在 `~/.config/opencode/AGENTS.md` 文件中设置全局规则。这些规则会应用于所有 opencode 会话。
由于此未提交给 Git 或与您的团队共享,因此我们建议使用它来指定 LLM 应遵循的任何个人规则。
由于该文件不会被提交到 Git 或与团队共享,我们建议用它来指定 LLM 应遵循的个人规则。
### 克劳德代码兼容性
### Claude Code 兼容性
Error 500 (Server Error)!!1500.That’s an error.There was an error. Please try again later.That’s all we know.
对于从 Claude Code 迁移过来的用户,OpenCode 支持 Claude Code 的文件约定作为回退方案:
- **项目规则**:项目目录中的`CLAUDE.md`(如果`AGENTS.md`不存在则使用)
- **全局规则**:`~/.claude/CLAUDE.md`(如果不存在`~/.config/opencode/AGENTS.md`则使用)
- **技能**:`~/.claude/skills/` — 详情请参见[代理技巧](/docs/skills/)
- **项目规则**:项目目录中的 `CLAUDE.md`(在没有 `AGENTS.md` 的情况下使用)
- **全局规则**:`~/.claude/CLAUDE.md`(在没有 `~/.config/opencode/AGENTS.md` 的情况下使用)
- **技能**:`~/.claude/skills/` — 详情请参阅[代理技能](/docs/skills/)
要取消Claude Code兼容性,请设置以下环境变量之一:
要禁用 Claude Code 兼容性,请设置以下环境变量之一:
```bash
export OPENCODE_DISABLE_CLAUDE_CODE=1 # Disable all .claude support
@@ -86,21 +86,21 @@ export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills
## 优先级
当opencode启动时,它会按以下顺序查找规则文件:
当 opencode 启动时,它会按以下顺序查找规则文件:
1. **本地文件**,从当前目录向上浏览(`AGENTS.md`,`CLAUDE.md`)
2. **全局文件** `~/.config/opencode/AGENTS.md`
3. **克劳德代码文件**位于`~/.claude/CLAUDE.md`(禁用禁用)
1. **本地文件**,从当前目录向上遍历(`AGENTS.md`、`CLAUDE.md`)
2. **全局文件**,位于 `~/.config/opencode/AGENTS.md`
3. **Claude Code 文件**,位于 `~/.claude/CLAUDE.md`(除非已禁用)
第一个匹配的文件每个在类别中触发。例如,如果您同时拥有`AGENTS.md`和`CLAUDE.md`,则仅使用`AGENTS.md`。同样,`~/.config/opencode/AGENTS.md`优先于`~/.claude/CLAUDE.md`。
在每个类别中,第一个匹配的文件优先。例如,如果您同时拥有 `AGENTS.md` 和 `CLAUDE.md`,则只会使用 `AGENTS.md`。同样,`~/.config/opencode/AGENTS.md` 优先于 `~/.claude/CLAUDE.md`。
---
## 自定义指令
您可以在 `opencode.json` 或全局 `~/.config/opencode/opencode.json` 中指定自定义指令文件。这允许您和您的团队重用现有规则,而不必将它们复制到 AGENTS.md。
您可以在 `opencode.json` 或全局配置文件 `~/.config/opencode/opencode.json` 中指定自定义指令文件。这允许您和团队复用现有规则,而无需将它们复制到 AGENTS.md 中。
例子:
示例:
```json title="opencode.json"
{
@@ -109,7 +109,7 @@ export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills
}
```
您还可以使用远程URL从Web加载说明。
您还可以使用远程 URL 从网络加载指令。
```json title="opencode.json"
{
@@ -118,19 +118,19 @@ export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills
}
```
远程指令的获取有 5 秒的超时时间。
远程指令的获取超时时间为 5 秒。
所有说明文件均与您的`AGENTS.md`文件合并。
所有指令文件都会与您的 `AGENTS.md` 文件合并。
---
## 引用外部文件
虽然opencode不会自动解析`AGENTS.md`中的文件引用,但您可以通过两种方式实现类似的功能:
虽然 opencode 不会自动解析 `AGENTS.md` 中的文件引用,但您可以通过以下两种方式实现类似的功能:
### 使用 opencode.json
推荐的方法是在`instructions`中使用`opencode.json`字段:
推荐的方式是使用 `opencode.json` 中的 `instructions` 字段:
```json title="opencode.json"
{
@@ -139,9 +139,9 @@ export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills
}
```
### AGENTS.md 中的手册说明
### 在 AGENTS.md 中手动指定
您可以通过在 `AGENTS.md` 中明确提供的指令来教 opencode 读取外部文件。这是一个实际的示例:
您可以在 `AGENTS.md` 中提供明确的指令,教 opencode 读取外部文件。以下是一个实际示例:
```markdown title="AGENTS.md"
# TypeScript Project Rules
@@ -168,13 +168,13 @@ For testing strategies and coverage requirements: @test/testing-guidelines.md
Read the following file immediately as it's relevant to all workflows: @rules/general-guidelines.md.
```
这种方法允许您:
这种方式允许您:
- 创建模块化、可重用的规则文件
- 通过符号链接或git子模块在项目之间共享规则
- 保持 AGENTS.md 简洁,同时参考详细指南
- 确保opencode仅在特定任务需要时加载文件
- 创建模块化、可复用的规则文件
- 通过符号链接或 Git 子模块在项目之间共享规则
- 保持 AGENTS.md 简洁,同时引用详细的指南
- 确保 opencode 仅在特定任务需要时才加载文件
:::tip
对于 monorepos 或具有共享标准的项目,使用 `opencode.json` 和 glob 模式(如 `packages/*/AGENTS.md`)比手动指令更易于维护。
对于 monorepo 或具有共享标准的项目,使用 `opencode.json` 配合 glob 模式(如 `packages/*/AGENTS.md`)比手动指定指令更易于维护。
:::