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

fix(docs): locale translations

Browse Source
This commit is contained in:
Adam
2026-02-10 07:11:19 -06:00
parent 19ad7ad809
commit 4c4e30cd71
351 changed files with 3744 additions and 3765 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/web/src/content/docs/zh-cn/sdk.mdx
+45 -45
View File
@@ -9,11 +9,11 @@ export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types
opencode JS/TS SDK 提供类型其他安全的客户端用于与服务器交互。
使用它以程序设计方式构建集成和控制opencode。
[了解更多关于服务器如何工作的](/docs/server)。例如，检视社区构建的[projects](/docs/ecosystem#projects)。
[了解更多关于服务器如何工作的](/docs/server)。例如，查看社区构建的[projects](/docs/ecosystem#projects)。
---
## 安裝
## 安装
从npm安装SDK：
@@ -33,14 +33,14 @@ import { createOpencode } from "@opencode-ai/sdk"
const { client } = await createOpencode()
```
這會同時啟動伺服器和客戶端
这会同時启动服务器和客戶端
#### 選項
| 選項 | 型別 | 描述 | 預設 |
| 選項 | 型別 | 描述 | 默认 |
| ---------- | ------------- | ------------------------------ | ----------- |
| `hostname` | `string` | 服务器主机名 | `127.0.0.1` |
| `port` | `number` | 伺服器埠 | `4096` |
| `port` | `number` | 服务器埠 | `4096` |
| `signal` | `AbortSignal` | 取消的中止讯号 | `undefined` |
| `timeout` | `number` | 服务器启动超时（以毫秒为单位） | `5000` |
| `config` | `Config` | 放置的财产 | `{}` |
@@ -67,7 +67,7 @@ console.log(`Server running at ${opencode.server.url}`)
opencode.server.close()
```
## 僅限客戶
## 仅限客戶
如果您已经有 opencode 的正在执行示例项，则可以创建一个客户端示例项来连线到它：
@@ -81,9 +81,9 @@ const client = createOpencodeClient({
#### 選項
| 選項 | 型別 | 描述 | 預設 |
| 選項 | 型別 | 描述 | 默认 |
| --------------- | ---------- | ---------------------------- | ----------------------- |
| `baseUrl` | `string` | 伺服器的 URL | `http://localhost:4096` |
| `baseUrl` | `string` | 服务器的 URL | `http://localhost:4096` |
| `fetch` | `function` | 习俗获取实现 | `globalThis.fetch` |
| `parseAs` | `string` | 响应解析方法 | `auto` |
| `responseStyle` | `string` | 返回样式：`data` 或 `fields` | `fields` |
@@ -99,11 +99,11 @@ SDK 包括所有 API 型以外的 TypeScript 定义。直接汇入其中：
import type { Session, Message, Part } from "@opencode-ai/sdk"
```
所有型別均根據伺服器的 OpenAPI 規範生成，並可在 <a href={typesUrl}> 型別檔案 </a> 中找到。
所有型別均根據服务器的 OpenAPI 規範生成，并可在 <a href={typesUrl}> 型別文件 </a> 中找到。
---
## 錯誤
## 错误
SDK 可能会丢掷错误，您可以捕获并处理这些错误：
@@ -125,7 +125,7 @@ SDK跨越型别安全客户端公开所有服务器API。
### 全球的
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| ----------------- | ------------------------ | ------------------------------------ |
| `global.health()` | 检查服务器健康状况和版本 | `{ healthy: true, version: string }` |
@@ -140,9 +140,9 @@ console.log(health.data.version)
---
### 應用程式
### 应用程序
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| -------------- | ------------------ | ------------------------------------------ |
| `app.log()` | 登录日志 | `boolean` |
| `app.agents()` | 列出所有可用的代理 | <a href={typesUrl}><code>代理[]</code></a> |
@@ -167,12 +167,12 @@ const agents = await client.app.agents()
---
### 專案
### 专案
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| ------------------- | ------------ | ------------------------------------------ |
| `project.list()` | 列出所有專案 | <a href={typesUrl}><code>專案[]</code></a> |
| `project.current()` | 獲取當前專案 | <a href={typesUrl}><code>專案</code></a> |
| `project.list()` | 列出所有专案 | <a href={typesUrl}><code>专案[]</code></a> |
| `project.current()` | 获取当前专案 | <a href={typesUrl}><code>专案</code></a> |
---
@@ -190,9 +190,9 @@ const currentProject = await client.project.current()
### 小路
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| ------------ | ------------ | ---------------------------------------- |
| `path.get()` | 獲取當前路徑 | <a href={typesUrl}><code>路徑</code></a> |
| `path.get()` | 获取当前路徑 | <a href={typesUrl}><code>路徑</code></a> |
---
@@ -207,10 +207,10 @@ const pathInfo = await client.path.get()
### 配置
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| -------------------- | -------------------- | --------------------------------------------------------------------------------------------------- |
| `config.get()` | 獲取配置資訊 | <a href={typesUrl}><code>配置</code></a> |
| `config.providers()` | 列出提供商和預設模型 | `{ providers: `<a href={typesUrl}><code>提供商[]</code></a>`, default: { [key: string]: string } }` |
| `config.get()` | 获取配置資訊 | <a href={typesUrl}><code>配置</code></a> |
| `config.providers()` | 列出提供商和默认模型 | `{ providers: `<a href={typesUrl}><code>提供商[]</code></a>`, default: { [key: string]: string } }` |
---
@@ -224,28 +224,28 @@ 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.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> |
| `session.unshare({ path })` | 取消共享會話 | 返回 <a href={typesUrl}><code>會話</code></a> |
| `session.share({ path })` | 分享会 | 返回 <a href={typesUrl}><code>会话</code></a> |
| `session.unshare({ path })` | 取消共享会话 | 返回 <a href={typesUrl}><code>会话</code></a> |
| `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.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> |
| `session.unrevert({ path })` | 恢復已恢復的訊息 | 返回 <a href={typesUrl}><code>會話</code></a> |
| `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.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> |
| `session.unrevert({ path })` | 恢复已恢复的消息 | 返回 <a href={typesUrl}><code>会话</code></a> |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | 回复许可权限请求 | 返回`boolean` |
---
@@ -281,15 +281,15 @@ 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` 支持一些可选的查询栏位：
@@ -324,7 +324,7 @@ const content = await client.file.read({
### TUI
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| ------------------------------ | ---------------- | --------- |
| `tui.appendPrompt({ body })` | 将文字附加到提示 | `boolean` |
| `tui.openHelp()` | 开启帮助对话方块 | `boolean` |
@@ -355,7 +355,7 @@ await client.tui.showToast({
### 授權
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| ------------------- | ---------------- | --------- |
| `auth.set({ ... })` | 设定身份验证凭据 | `boolean` |
@@ -372,9 +372,9 @@ await client.auth.set({
---
### 活動
### 活动
| 方法 | 描述 | 回應 |
| 方法 | 描述 | 回应 |
| ------------------- | ------------------ | ------------------ |
| `event.subscribe()` | 服务器传送的事件流 | 服务器传送的事件流 |