mirror of
https://gitea.toothfairyai.com/ToothFairyAI/tf_code.git
synced 2026-04-18 22:54:41 +00:00
chore: generate
This commit is contained in:
opencode-agent[bot]
@@ -37,13 +37,13 @@ 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` | 配置對象 | `{}` |
|
||||
|
||||
---
|
||||
|
||||
@@ -81,13 +81,13 @@ const client = createOpencodeClient({
|
||||
|
||||
#### 選項
|
||||
|
||||
|選項 |類型 |描述 |默認|
|
||||
| --------------- | ---------- | -------------------------------- | ----------------------- |
|
||||
| `baseUrl` | `string` |服務器的 URL | `http://localhost:4096` |
|
||||
| `fetch` | `function` |自定義獲取實現 | `globalThis.fetch` |
|
||||
| `parseAs` | `string` |響應解析方法 | `auto` |
|
||||
| `responseStyle` | `string` |返回樣式：`data` 或 `fields` | `fields` |
|
||||
| `throwOnError` | `boolean` |拋出錯誤而不是返回 | `false` |
|
||||
| 選項 | 類型 | 描述 | 默認 |
|
||||
| --------------- | ---------- | ---------------------------- | ----------------------- |
|
||||
| `baseUrl` | `string` | 服務器的 URL | `http://localhost:4096` |
|
||||
| `fetch` | `function` | 自定義獲取實現 | `globalThis.fetch` |
|
||||
| `parseAs` | `string` | 響應解析方法 | `auto` |
|
||||
| `responseStyle` | `string` | 返回樣式：`data` 或 `fields` | `fields` |
|
||||
| `throwOnError` | `boolean` | 拋出錯誤而不是返回 | `false` |
|
||||
|
||||
---
|
||||
|
||||
@@ -125,9 +125,9 @@ SDK 通過類型安全的客戶端公開所有服務器 API。
|
||||
|
||||
### 全球的
|
||||
|
||||
|方法|描述 |回應 |
|
||||
| ----------------- | ------------------------------- | ------------------------------------ |
|
||||
| `global.health()` |檢查服務器健康狀況和版本 | `{ healthy: true, version: string }` |
|
||||
| 方法 | 描述 | 回應 |
|
||||
| ----------------- | ------------------------ | ------------------------------------ |
|
||||
| `global.health()` | 檢查服務器健康狀況和版本 | `{ healthy: true, version: string }` |
|
||||
|
||||
---
|
||||
|
||||
@@ -142,10 +142,10 @@ 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>代理[]</code></a> |
|
||||
|
||||
---
|
||||
|
||||
@@ -169,10 +169,10 @@ 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>Provider[]</code></a>`, default: { [key: string]: string } }` |
|
||||
| 方法 | 描述 | 回應 |
|
||||
| -------------------- | -------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `config.get()` | 獲取配置信息 | <a href={typesUrl}><code>配置</code></a> |
|
||||
| `config.providers()` | 列出提供商和默認模型 | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
|
||||
|
||||
---
|
||||
|
||||
@@ -226,27 +226,27 @@ 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>消息</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` |
|
||||
|
||||
---
|
||||
|
||||
@@ -283,13 +283,13 @@ 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> |
|
||||
| `file.read({ query })` |讀取文件 | `{ type: "raw" \| "patch", content: string }` |
|
||||
| `file.status({ query? })` |獲取跟踪文件的狀態 | <a href={typesUrl}><code>文件[]</code></a> |
|
||||
| 方法 | 描述 | 回應 |
|
||||
| ------------------------- | -------------------- | -------------------------------------------------------------------- | -------------- |
|
||||
| `find.text({ query })` | 搜索文件中的文本 | 具有 `path`、`lines`、`line_number`、`absolute_offset`、`submatches` | 的匹配對像數組 |
|
||||
| `find.files({ query })` | 按名稱查找文件和目錄 | `string[]`（路徑） |
|
||||
| `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> |
|
||||
|
||||
`find.files` 支持一些可選的查詢字段：
|
||||
|
||||
@@ -324,17 +324,17 @@ 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` |
|
||||
|
||||
---
|
||||
|
||||
@@ -355,9 +355,9 @@ await client.tui.showToast({
|
||||
|
||||
### 授權
|
||||
|
||||
|方法|描述 |回應 |
|
||||
| ------------------- | ------------------------------ | --------- |
|
||||
| `auth.set({ ... })` |設置身份驗證憑據 | `boolean` |
|
||||
| 方法 | 描述 | 回應 |
|
||||
| ------------------- | ---------------- | --------- |
|
||||
| `auth.set({ ... })` | 設置身份驗證憑據 | `boolean` |
|
||||
|
||||
---
|
||||
|
||||
@@ -374,9 +374,9 @@ await client.auth.set({
|
||||
|
||||
### 活動
|
||||
|
||||
|方法|描述 |回應 |
|
||||
| ------------------- | ------------------------- | ------------------------- |
|
||||
| `event.subscribe()` |服務器發送的事件流 |服務器發送的事件流 |
|
||||
| 方法 | 描述 | 回應 |
|
||||
| ------------------- | ------------------ | ------------------ |
|
||||
| `event.subscribe()` | 服務器發送的事件流 | 服務器發送的事件流 |
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user