ToothFairyAI_Public/tf_code
1
0
Fork 0
mirror of https://gitea.toothfairyai.com/ToothFairyAI/tf_code.git synced 2026-04-17 22:24:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): locale translations for nav elements and headings

Browse Source
This commit is contained in:
Adam
2026-02-11 18:51:27 -06:00
parent 8eea53a41e
commit aea68c386a
484 changed files with 12718 additions and 11212 deletions
Download Patch File Download Diff File Expand all files Collapse all files

194
packages/web/src/content/docs/zh-tw/sdk.mdx
View File

@@ -1,15 +1,15 @@
---
title: 軟件開發工具包
description: opencode 服務器的類型安全 JS 客戶端。
title: SDK
description: opencode 伺服器的類型安全 JS 客戶端。
---
import config from "../../../../config.mjs"
export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts`
opencode JS/TS SDK 提供類型安全的客戶端用於與服務器交互。
使用它以編程方式構建集成和控制opencode。
opencode JS/TS SDK 提供類型安全的客戶端用於與伺服器互動。
使用它以程式化方式構建整合和控制 opencode。
[了解更多](/docs/server) 關於服務器如何工作。例如，查看社區構建的[專案](/docs/ecosystem#projects)。
[了解更多](/docs/server) 關於伺服器如何工作。例如，查看社群構建的[專案](/docs/ecosystem#projects)。
---
@@ -23,9 +23,9 @@ npm install @opencode-ai/sdk
---
## 創建客戶端
## 建立客戶端
創建 opencode 的實例：
建立 opencode 的實例：
```javascript
import { createOpencode } from "@opencode-ai/sdk"
@@ -33,23 +33,23 @@ import { createOpencode } from "@opencode-ai/sdk"
const { client } = await createOpencode()
```
這會同時啟動服務器和客戶端
這會同時啟動伺服器和客戶端
#### 選項
| 選項 | 類型 | 描述 | 默認 |
| 選項 | 類型 | 描述 | 預設 |
| ---------- | ------------- | ------------------------------ | ----------- |
| `hostname` | `string` | 服務器主機名 | `127.0.0.1` |
| `port` | `number` | 服務器端口 | `4096` |
| `signal` | `AbortSignal` | 取消的中止信號 | `undefined` |
| `timeout` | `number` | 服務器啟動超時（以毫秒為單位） | `5000` |
| `config` | `Config` | 配置對象 | `{}` |
| `hostname` | `string` | 伺服器主機名稱 | `127.0.0.1` |
| `port` | `number` | 伺服器連接埠 | `4096` |
| `signal` | `AbortSignal` | 取消的中止訊號 | `undefined` |
| `timeout` | `number` | 伺服器啟動超時（以毫秒為單位） | `5000` |
| `config` | `Config` | 設定物件 | `{}` |
---
## 配置
您可以傳遞配置對象來自定義行為。該實例仍然會選擇您的`opencode.json`，但您可以覆蓋或添加內聯配置：
您可以傳遞設定物件來自定義行為。該實例仍然會選擇您的 `opencode.json`，但您可以覆寫或添加內聯設定：
```javascript
import { createOpencode } from "@opencode-ai/sdk"
@@ -67,9 +67,9 @@ console.log(`Server running at ${opencode.server.url}`)
opencode.server.close()
```
## 僅限客戶
## 僅限客戶端
如果您已經有一個正在運行的 opencode 實例，您可以創建一個客戶端實例來連接到它：
如果您已經有一個正在執行的 opencode 實例，您可以建立一個客戶端實例來連接到它：
```javascript
import { createOpencodeClient } from "@opencode-ai/sdk"
@@ -81,11 +81,11 @@ const client = createOpencodeClient({
#### 選項
| 選項 | 類型 | 描述 | 默認 |
| 選項 | 類型 | 描述 | 預設 |
| --------------- | ---------- | ---------------------------- | ----------------------- |
| `baseUrl` | `string` | 服務器的 URL | `http://localhost:4096` |
| `fetch` | `function` | 自定義獲取實現 | `globalThis.fetch` |
| `parseAs` | `string` | 響應解析方法 | `auto` |
| `baseUrl` | `string` | 伺服器的 URL | `http://localhost:4096` |
| `fetch` | `function` | 自定義 fetch 實作 | `globalThis.fetch` |
| `parseAs` | `string` | 回應解析方法 | `auto` |
| `responseStyle` | `string` | 返回樣式：`data` 或 `fields` | `fields` |
| `throwOnError` | `boolean` | 拋出錯誤而不是返回 | `false` |
@@ -93,19 +93,19 @@ const client = createOpencodeClient({
## 類型
SDK 包含所有 API 類型的 TypeScript 定義。直接導入它們：
SDK 包含所有 API 類型的 TypeScript 定義。直接匯入它們：
```typescript
import type { Session, Message, Part } from "@opencode-ai/sdk"
```
所有類型均根據服務器的 OpenAPI 規範生成，並可在 <a href={typesUrl}>types 文件</a>中找到。
所有類型均根據伺服器的 OpenAPI 規範生成，並可在 <a href={typesUrl}>types 檔案</a>中找到。
---
## 錯誤
SDK 可能會拋出錯誤，您可以捕獲並處理這些錯誤：
SDK 可能會拋出錯誤，您可以捕捉並處理這些錯誤：
```typescript
try {
@@ -117,21 +117,21 @@ try {
---
## 蜜蜂
## API
SDK 通過類型安全的客戶端公開所有服務器 API。
SDK 透過類型安全的客戶端公開所有伺服器 API。
---
### 全球的
### 全域
| 方法 | 描述 | 回應 |
| ----------------- | ------------------------ | ------------------------------------ |
| `global.health()` | 檢查服務器健康狀況和版本 | `{ healthy: true, version: string }` |
| `global.health()` | 檢查伺服器健康狀態和版本 | `{ healthy: true, version: string }` |
---
#### 示例
#### 範例
```javascript
const health = await client.global.health()
@@ -142,14 +142,14 @@ console.log(health.data.version)
### 應用程式
| 方法 | 描述 | 回應 |
| -------------- | ------------------ | ------------------------------------------ |
| `app.log()` | 寫入日誌條目 | `boolean` |
| `app.agents()` | 列出所有可用的代理 | <a href={typesUrl}><code>代理[]</code></a> |
| 方法 | 描述 | 回應 |
| -------------- | ------------------ | ------------------------------------------- |
| `app.log()` | 寫入日誌項目 | `boolean` |
| `app.agents()` | 列出所有可用的代理 | <a href={typesUrl}><code>Agent[]</code></a> |
---
#### 示例
#### 範例
```javascript
// Write a log entry
@@ -169,14 +169,14 @@ 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>Project[]</code></a> |
| `project.current()` | 獲取當前專案 | <a href={typesUrl}><code>Project</code></a> |
---
#### 示例
#### 範例
```javascript
// List all projects
@@ -188,15 +188,15 @@ const currentProject = await client.project.current()
---
### 小路
### 路徑
| 方法 | 描述 | 回應 |
| ------------ | ------------ | ---------------------------------------- |
| `path.get()` | 獲取當前路徑 | <a href={typesUrl}><code>路徑</code></a> |
| `path.get()` | 獲取當前路徑 | <a href={typesUrl}><code>Path</code></a> |
---
#### 示例
#### 範例
```javascript
// Get current path information
@@ -209,12 +209,12 @@ const pathInfo = await client.path.get()
| 方法 | 描述 | 回應 |
| -------------------- | -------------------- | ----------------------------------------------------------------------------------------------------- |
| `config.get()` | 獲取配置信息 | <a href={typesUrl}><code>配置</code></a> |
| `config.providers()` | 列出提供商和默認模型 | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
| `config.get()` | 獲取設定資訊 | <a href={typesUrl}><code>Config</code></a> |
| `config.providers()` | 列出供應商和預設模型 | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
---
#### 示例
#### 範例
```javascript
const config = await client.config.get()
@@ -224,33 +224,33 @@ const { providers, default: defaults } = await client.config.providers()
---
### 會議
### 工作階段
| 方法 | 描述 | 筆記 |
| ---------------------------------------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `session.list()` | 列出會話 | 返回 <a href={typesUrl}><code>Session[]</code></a> |
| `session.get({ path })` | 獲取會話 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.children({ path })` | 列出子會話 | 返回 <a href={typesUrl}><code>Session[]</code></a> |
| `session.create({ body })` | 創建會話 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.delete({ path })` | 刪除會話 | 返回 `boolean` |
| `session.update({ path, body })` | 更新會話屬性 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.init({ path, body })` | 分析應用程式並創建`AGENTS.md` | 返回 `boolean` |
| `session.abort({ path })` | 中止正在運行的會話 | 返回 `boolean` |
| `session.share({ path })` | 分享會 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.unshare({ path })` | 取消共享會話 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.summarize({ path, body })` | 會議總結 | 返回 `boolean` |
| `session.messages({ path })` | 列出會話中的消息 | 返回 `{ info: `<a href={typesUrl}><code>消息</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` |
| `session.message({ path })` | 獲取消息詳情 | 返回 `{ info: `<a href={typesUrl}><code>消息</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.prompt({ path, body })` | 發送提示信息 | `body.noReply: true` 返回 UserMessage（僅上下文）。默認返回帶有 AI 響應的 <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.command({ path, body })` | 向會話發送命令 | 返回 `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.shell({ path, body })` | 運行 shell 命令 | 返回 <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.revert({ path, body })` | 回复消息 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.unrevert({ path })` | 恢復已恢復的消息 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | 回復權限請求 | 返回 `boolean` |
| 方法 | 描述 | 備註 |
| ---------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `session.list()` | 列出工作階段 | 返回 <a href={typesUrl}><code>Session[]</code></a> |
| `session.get({ path })` | 獲取工作階段 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.children({ path })` | 列出子工作階段 | 返回 <a href={typesUrl}><code>Session[]</code></a> |
| `session.create({ body })` | 建立工作階段 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.delete({ path })` | 刪除工作階段 | 返回 `boolean` |
| `session.update({ path, body })` | 更新工作階段屬性 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.init({ path, body })` | 分析應用程式並建立 `AGENTS.md` | 返回 `boolean` |
| `session.abort({ path })` | 中止正在執行的工作階段 | 返回 `boolean` |
| `session.share({ path })` | 分享工作階段 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.unshare({ path })` | 取消分享工作階段 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.summarize({ path, body })` | 工作階段摘要 | 返回 `boolean` |
| `session.messages({ path })` | 列出工作階段中的訊息 | 返回 `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` |
| `session.message({ path })` | 獲取訊息詳情 | 返回 `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.prompt({ path, body })` | 發送提示訊息 | `body.noReply: true` 返回 UserMessage（僅上下文）。預設返回帶有 AI 回應的 <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.command({ path, body })` | 向工作階段發送指令 | 返回 `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.shell({ path, body })` | 執行 shell 指令 | 返回 <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.revert({ path, body })` | 還原訊息 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `session.unrevert({ path })` | 恢復已還原的訊息 | 返回 <a href={typesUrl}><code>Session</code></a> |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | 回覆權限請求 | 返回 `boolean` |
---
#### 示例
#### 範例
```javascript
// Create and manage sessions
@@ -281,25 +281,25 @@ 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>Symbol[]</code></a> |
| `file.read({ query })` | 讀取文件 | `{ type: "raw" \| "patch", content: string }` |
| `file.status({ query? })` | 獲取跟蹤文件的狀態 | <a href={typesUrl}><code>File[]</code></a> |
| `find.text({ query })` | 搜尋檔案中的文字 | 具有 `path`, `lines`, `line_number`, `absolute_offset`, `submatches` 的匹配物件陣列 |
| `find.files({ query })` | 按名稱尋找檔案和目錄 | `string[]`（路徑） |
| `find.symbols({ query })` | 尋找工作區符號 | <a href={typesUrl}><code>Symbol[]</code></a> |
| `file.read({ query })` | 讀取檔案 | `{ type: "raw" \| "patch", content: string }` |
| `file.status({ query? })` | 獲取追蹤檔案的狀態 | <a href={typesUrl}><code>File[]</code></a> |
`find.files` 支持一些可選的查詢字段：
`find.files` 支援一些可選的查詢欄位：
- `type`：`"file"`或`"directory"`
- `directory`：覆蓋搜索的項目根目錄
- `type`：`"file"` 或 `"directory"`
- `directory`：覆寫搜尋的專案根目錄
- `limit`：最大結果 (1–200)
---
#### 示例
#### 範例
```javascript
// Search and read files
@@ -324,21 +324,21 @@ const content = await client.file.read({
### TUI
| 方法 | 描述 | 回應 |
| ------------------------------ | ---------------- | --------- |
| `tui.appendPrompt({ body })` | 將文本附加到提示 | `boolean` |
| `tui.openHelp()` | 打開幫助對話框 | `boolean` |
| `tui.openSessions()` | 打開會話選擇器 | `boolean` |
| `tui.openThemes()` | 打開主題選擇器 | `boolean` |
| `tui.openModels()` | 打開模型選擇器 | `boolean` |
| `tui.submitPrompt()` | 提交當前提示 | `boolean` |
| `tui.clearPrompt()` | 清除提示 | `boolean` |
| `tui.executeCommand({ body })` | 執行命令 | `boolean` |
| `tui.showToast({ body })` | 顯示 toast 通知 | `boolean` |
| 方法 | 描述 | 回應 |
| ------------------------------ | ------------------ | --------- |
| `tui.appendPrompt({ body })` | 將文字附加到提示 | `boolean` |
| `tui.openHelp()` | 打開說明對話方塊 | `boolean` |
| `tui.openSessions()` | 打開工作階段選擇器 | `boolean` |
| `tui.openThemes()` | 打開主題選擇器 | `boolean` |
| `tui.openModels()` | 打開模型選擇器 | `boolean` |
| `tui.submitPrompt()` | 提交當前提示 | `boolean` |
| `tui.clearPrompt()` | 清除提示 | `boolean` |
| `tui.executeCommand({ body })` | 執行指令 | `boolean` |
| `tui.showToast({ body })` | 顯示 Toast 通知 | `boolean` |
---
#### 示例
#### 範例
```javascript
// Control TUI interface
@@ -357,11 +357,11 @@ await client.tui.showToast({
| 方法 | 描述 | 回應 |
| ------------------- | ---------------- | --------- |
| `auth.set({ ... })` | 設置身份驗證憑據 | `boolean` |
| `auth.set({ ... })` | 設定身分驗證憑證 | `boolean` |
---
#### 示例
#### 範例
```javascript
await client.auth.set({
@@ -372,15 +372,15 @@ await client.auth.set({
---
### 活動
### 事件
| 方法 | 描述 | 回應 |
| ------------------- | ------------------ | ------------------ |
| `event.subscribe()` | 服務器發送的事件流 | 服務器發送的事件流 |
| 方法 | 描述 | 回應 |
| ------------------- | -------------------- | -------------------- |
| `event.subscribe()` | 伺服器發送的事件串流 | 伺服器發送的事件串流 |
---
#### 示例
#### 範例
```javascript
// Listen to real-time events