EnterpriseAI/ClosedCode
1
0
Fork 0
Code Issues Pull Requests Actions 34 Packages Projects Releases Wiki Activity

fix: standardize zh-CN docs character set and terminology (#13500)

Browse Source
This commit is contained in:
Niu Shuai
2026-02-13 12:58:12 -06:00
committed by GitHub
parent bc1fd0633d
commit 72c09e1dcc
18 changed files with 305 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/web/src/content/docs/zh-cn/sdk.mdx
+9 -9
View File
@@ -33,7 +33,7 @@ import { createOpencode } from "@opencode-ai/sdk"
const { client } = await createOpencode()
```
这会同時启动服务器和客戶端
这会同时启动服务器和客户端
#### 选项
@@ -99,7 +99,7 @@ SDK 包括所有 API 型以外的 TypeScript 定义。直接汇入其中：
import type { Session, Message, Part } from "@opencode-ai/sdk"
```
所有型別均根據服务器的 OpenAPI 規範生成，并可在 <a href={typesUrl}> 型別文件 </a> 中找到。
所有型别均根据服务器的 OpenAPI 规范生成，并可在 <a href={typesUrl}> 型别文件 </a> 中找到。
---
@@ -192,7 +192,7 @@ const currentProject = await client.project.current()
| 方法 | 描述 | 回应 |
| ------------ | ------------ | ---------------------------------------- |
| `path.get()` | 获取当前路徑 | <a href={typesUrl}><code>路徑</code></a> |
| `path.get()` | 获取当前路径 | <a href={typesUrl}><code>路径</code></a> |
---
@@ -209,7 +209,7 @@ const pathInfo = await client.path.get()
| 方法 | 描述 | 回应 |
| -------------------- | -------------------- | --------------------------------------------------------------------------------------------------- |
| `config.get()` | 获取配置資訊 | <a href={typesUrl}><code>配置</code></a> |
| `config.get()` | 获取配置资讯 | <a href={typesUrl}><code>配置</code></a> |
| `config.providers()` | 列出提供商和默认模型 | `{ providers: `<a href={typesUrl}><code>提供商[]</code></a>`, default: { [key: string]: string } }` |
---
@@ -226,14 +226,14 @@ const { providers, default: defaults } = await client.config.providers()
### 会话
| 方法 | 描述 | 筆記 |
| 方法 | 描述 | 备注 |
| ---------------------------------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `session.list()` | 列出会话 | 返回 <a href={typesUrl}><code>Session[]</code></a> |
| `session.get({ path })` | 获取会话 | 返回 <a href={typesUrl}><code>会话</code></a> |
| `session.children({ path })` | 列出子会话 | 返回 <a href={typesUrl}><code>Session[]</code></a> |
| `session.create({ body })` | 建立会话 | 返回 <a href={typesUrl}><code>会话</code></a> |
| `session.delete({ path })` | 离开会话 | 返回`boolean` |
| `session.update({ path, body })` | 更新会话屬性 | 返回 <a href={typesUrl}><code>会话</code></a> |
| `session.update({ path, body })` | 更新会话属性 | 返回 <a href={typesUrl}><code>会话</code></a> |
| `session.init({ path, body })` | Analyze app and create `AGENTS.md` | Returns `boolean` |
| `session.abort({ path })` | 中止正在执行的会话 | 返回`boolean` |
| `session.share({ path })` | 分享会 | 返回 <a href={typesUrl}><code>会话</code></a> |
@@ -241,7 +241,7 @@ const { providers, default: defaults } = await client.config.providers()
| `session.summarize({ path, body })` | 会议总结 | 返回`boolean` |
| `session.messages({ path })` | 列出会话中的消息 | 返回 `{ info: `<a href={typesUrl}><code>消息</code></a>`, parts: `<a href={typesUrl}><code>部分[]</code></a>`}[]` |
| `session.message({ path })` | 获取消息详情 | 返回 `{ info: `<a href={typesUrl}><code>消息</code></a>`, parts: `<a href={typesUrl}><code>部分[]</code></a>`}` |
| `session.prompt({ path, body })` | 发送提示資訊 | `body.noReply: true` 返回 UserMessage（仅限上下文）。默认返回 <a href={typesUrl}><code>AssistantMessage</code></a> 以及 AI 響应 |
| `session.prompt({ path, body })` | 发送提示资讯 | `body.noReply: true` 返回 UserMessage（仅限上下文）。默认返回 <a href={typesUrl}><code>AssistantMessage</code></a> 以及 AI 响应 |
| `session.command({ path, body })` | 向会话发送命令 | 返回 `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>部分[]</code></a>`}` |
| `session.shell({ path, body })` | 执行 shell 命令 | 返回 <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.revert({ path, body })` | 回复消息 | 返回 <a href={typesUrl}><code>会话</code></a> |
@@ -287,9 +287,9 @@ await client.session.prompt({
| ------------------------- | -------------------- | ----------------------------------------------------------------------------------- |
| `find.text({ query })` | 搜索档案中文字 | 具有 `path`、`lines`、`line_number`、`absolute_offset`、`submatches` 的匹配对象数组 |
| `find.files({ query })` | 按名称查询档案和目录 | `string[]`（路径） |
| `find.symbols({ query })` | 查询工作区符號 | <a href={typesUrl}><code>符號[]</code></a> |
| `find.symbols({ query })` | 查询工作区符号 | <a href={typesUrl}><code>符号[]</code></a> |
| `file.read({ query })` | 读取档案 | `{ type: "raw" \| "patch", content: string }` |
| `file.status({ query? })` | 获取跟蹤文件的狀態 | <a href={typesUrl}><code>文件[]</code></a> |
| `file.status({ query? })` | 获取跟踪文件的状态 | <a href={typesUrl}><code>文件[]</code></a> |
`find.files` 支持一些可选的查询栏位：