@neurocode-ai/web 1.18.8

package/src/content/docs/zh-tw/rules.mdx

@@ -0,0 +1,180 @@
+---
+title: 規則
+description: 為 opencode 設定自訂指令。
+---
+
+您可以透過建立 `AGENTS.md` 檔案來為 opencode 提供自訂指令。這類似於 Cursor 的規則功能。該檔案包含的指令會被納入 LLM 的上下文中，以便針對您的特定專案自訂其行為。
+
+---
+
+## 初始化
+
+要建立新的 `AGENTS.md` 檔案，您可以在 opencode 中執行 `/init` 指令。
+
+:::tip
+您應該將專案的 `AGENTS.md` 檔案提交到 Git。
+:::
+
+該指令會掃描您的專案及其所有內容，了解專案的用途，並據此產生一個 `AGENTS.md` 檔案。這有助於 opencode 更好地導覽您的專案。
+
+如果您已有 `AGENTS.md` 檔案，該指令會嘗試在其基礎上進行補充。
+
+---
+
+## 範例
+
+您也可以手動建立此檔案。以下是一些可以放入 `AGENTS.md` 檔案中的內容範例。
+
+```markdown title="AGENTS.md"
+# SST v3 Monorepo Project
+
+This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management.
+
+## Project Structure
+
+- `packages/` - Contains all workspace packages (functions, core, web, etc.)
+- `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts)
+- `sst.config.ts` - Main SST configuration with dynamic imports
+
+## Code Standards
+
+- Use TypeScript with strict mode enabled
+- Shared code goes in `packages/core/` with proper exports configuration
+- Functions go in `packages/functions/`
+- Infrastructure should be split into logical files in `infra/`
+
+## Monorepo Conventions
+
+- Import shared modules using workspace names: `@my-app/core/example`
+```
+
+我們在這裡新增了專案特定的指令，這些指令會在您的團隊中共享。
+
+---
+
+## 類型
+
+opencode 還支援從多個位置讀取 `AGENTS.md` 檔案，不同的位置有不同的用途。
+
+### 專案級
+
+在專案根目錄放置一個 `AGENTS.md` 檔案，用於定義專案特定的規則。這些規則僅在您於該目錄或其子目錄中工作時生效。
+
+### 全域級
+
+您還可以在 `~/.config/opencode/AGENTS.md` 檔案中設定全域規則。這些規則會套用於所有 opencode 工作階段。
+
+由於該檔案不會被提交到 Git 或與團隊共享，我們建議用它來指定 LLM 應遵循的個人規則。
+
+### Claude Code 相容性
+
+對於從 Claude Code 遷移過來的使用者，OpenCode 支援 Claude Code 的檔案慣例作為備援方案：
+
+- **專案規則**：專案目錄中的 `CLAUDE.md`（在沒有 `AGENTS.md` 的情況下使用）
+- **全域規則**：`~/.claude/CLAUDE.md`（在沒有 `~/.config/opencode/AGENTS.md` 的情況下使用）
+- **技能**：`~/.claude/skills/` — 詳情請參閱[代理技能](/docs/skills/)
+
+要停用 Claude Code 相容性，請設定以下環境變數之一：
+
+```bash
+export OPENCODE_DISABLE_CLAUDE_CODE=1        # Disable all .claude support
+export OPENCODE_DISABLE_CLAUDE_CODE_PROMPT=1 # Disable only ~/.claude/CLAUDE.md
+export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills
+```
+
+---
+
+## 優先順序
+
+當 opencode 啟動時，它會按以下順序尋找規則檔案：
+
+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`。
+
+---
+
+## 自訂指令
+
+您可以在 `opencode.json` 或全域設定檔 `~/.config/opencode/opencode.json` 中指定自訂指令檔案。這允許您和團隊複用現有規則，而無需將它們複製到 AGENTS.md 中。
+
+範例：
+
+```json title="opencode.json"
+{
+  "$schema": "https://opencode.ai/config.json",
+  "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
+}
+```
+
+您還可以使用遠端 URL 從網路載入指令。
+
+```json title="opencode.json"
+{
+  "$schema": "https://opencode.ai/config.json",
+  "instructions": ["https://raw.githubusercontent.com/my-org/shared-rules/main/style.md"]
+}
+```
+
+遠端指令的擷取逾時時間為 5 秒。
+
+所有指令檔案都會與您的 `AGENTS.md` 檔案合併。
+
+---
+
+## 參照外部檔案
+
+雖然 opencode 不會自動解析 `AGENTS.md` 中的檔案參照，但您可以透過以下兩種方式實現類似的功能：
+
+### 使用 opencode.json
+
+建議的方式是使用 `opencode.json` 中的 `instructions` 欄位：
+
+```json title="opencode.json"
+{
+  "$schema": "https://opencode.ai/config.json",
+  "instructions": ["docs/development-standards.md", "test/testing-guidelines.md", "packages/*/AGENTS.md"]
+}
+```
+
+### 在 AGENTS.md 中手動指定
+
+您可以在 `AGENTS.md` 中提供明確的指令，教 opencode 讀取外部檔案。以下是一個實際範例：
+
+```markdown title="AGENTS.md"
+# TypeScript Project Rules
+
+## External File Loading
+
+CRITICAL: When you encounter a file reference (e.g., @rules/general.md), use your Read tool to load it on a need-to-know basis. They're relevant to the SPECIFIC task at hand.
+
+Instructions:
+
+- Do NOT preemptively load all references - use lazy loading based on actual need
+- When loaded, treat content as mandatory instructions that override defaults
+- Follow references recursively when needed
+
+## Development Guidelines
+
+For TypeScript code style and best practices: @docs/typescript-guidelines.md
+For React component architecture and hooks patterns: @docs/react-patterns.md
+For REST API design and error handling: @docs/api-standards.md
+For testing strategies and coverage requirements: @test/testing-guidelines.md
+
+## General Guidelines
+
+Read the following file immediately as it's relevant to all workflows: @rules/general-guidelines.md.
+```
+
+這種方式允許您：
+
+- 建立模組化、可複用的規則檔案
+- 透過符號連結或 Git 子模組在專案之間共享規則
+- 保持 AGENTS.md 簡潔，同時參照詳細的指南
+- 確保 opencode 僅在特定任務需要時才載入檔案
+
+:::tip
+對於 monorepo 或具有共享標準的專案，使用 `opencode.json` 搭配 glob 模式（如 `packages/*/AGENTS.md`）比手動指定指令更易於維護。
+:::

package/src/content/docs/zh-tw/sdk.mdx

@@ -0,0 +1,463 @@
+---
+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。
+
+[了解更多](/docs/server)關於伺服器的運作原理。如需範例，請查看社群建構的[專案](/docs/ecosystem#projects)。
+
+---
+
+## 安裝
+
+從 npm 安裝 SDK：
+
+```bash
+npm install @opencode-ai/sdk
+```
+
+---
+
+## 建立用戶端
+
+建立一個 opencode 實例：
+
+```javascript
+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`      | 設定物件                   | `{}`        |
+
+---
+
+## 設定
+
+您可以傳入一個設定物件來自訂行為。實例仍然會讀取您的 `opencode.json`，但您可以透過內嵌方式覆寫或新增設定：
+
+```javascript
+import { createOpencode } from "@opencode-ai/sdk"
+
+const opencode = await createOpencode({
+  hostname: "127.0.0.1",
+  port: 4096,
+  config: {
+    model: "anthropic/claude-3-5-sonnet-20241022",
+  },
+})
+
+console.log(`Server running at ${opencode.server.url}`)
+
+opencode.server.close()
+```
+
+## 僅用戶端模式
+
+如果您已經有一個正在執行的 opencode 實例，可以建立一個用戶端實例來連線：
+
+```javascript
+import { createOpencodeClient } from "@opencode-ai/sdk"
+
+const client = createOpencodeClient({
+  baseUrl: "http://localhost:4096",
+})
+```
+
+#### 選項
+
+| 選項            | 型別       | 描述                         | 預設值                  |
+| --------------- | ---------- | ---------------------------- | ----------------------- |
+| `baseUrl`       | `string`   | 伺服器 URL                   | `http://localhost:4096` |
+| `fetch`         | `function` | 自訂 fetch 實作              | `globalThis.fetch`      |
+| `parseAs`       | `string`   | 回應解析方式                 | `auto`                  |
+| `responseStyle` | `string`   | 回傳風格：`data` 或 `fields` | `fields`                |
+| `throwOnError`  | `boolean`  | 拋出錯誤而非回傳錯誤         | `false`                 |
+
+---
+
+## 型別
+
+SDK 包含所有 API 型別的 TypeScript 定義。您可以直接匯入它們：
+
+```typescript
+import type { Session, Message, Part } from "@opencode-ai/sdk"
+```
+
+所有型別均根據伺服器的 OpenAPI 規範產生，可在<a href={typesUrl}>型別檔案</a>中查看。
+
+---
+
+## 錯誤處理
+
+SDK 可能會拋出錯誤，您可以捕捉並處理這些錯誤：
+
+```typescript
+try {
+  await client.session.get({ path: { id: "invalid-id" } })
+} catch (error) {
+  console.error("Failed to get session:", (error as Error).message)
+}
+```
+
+---
+
+## 結構化輸出
+
+您可以透過指定帶有 JSON Schema 的 `format` 來請求模型回傳結構化的 JSON 輸出。模型會使用 `StructuredOutput` 工具回傳符合您 Schema 的經過驗證的 JSON。
+
+### 基本用法
+
+```typescript
+const result = await client.session.prompt({
+  path: { id: sessionId },
+  body: {
+    parts: [{ type: "text", text: "Research Anthropic and provide company info" }],
+    format: {
+      type: "json_schema",
+      schema: {
+        type: "object",
+        properties: {
+          company: { type: "string", description: "Company name" },
+          founded: { type: "number", description: "Year founded" },
+          products: {
+            type: "array",
+            items: { type: "string" },
+            description: "Main products",
+          },
+        },
+        required: ["company", "founded"],
+      },
+    },
+  },
+})
+
+// Access the structured output
+console.log(result.data.info.structured_output)
+// { company: "Anthropic", founded: 2021, products: ["Claude", "Claude API"] }
+```
+
+### 輸出格式型別
+
+| 型別          | 描述                                    |
+| ------------- | --------------------------------------- |
+| `text`        | 預設值。標準文字回應（無結構化輸出）    |
+| `json_schema` | 回傳符合所提供 Schema 的經過驗證的 JSON |
+
+### JSON Schema 格式
+
+使用 `type: 'json_schema'` 時，需提供以下欄位：
+
+| 欄位         | 型別            | 描述                                  |
+| ------------ | --------------- | ------------------------------------- |
+| `type`       | `'json_schema'` | 必填。指定 JSON Schema 模式           |
+| `schema`     | `object`        | 必填。定義輸出結構的 JSON Schema 物件 |
+| `retryCount` | `number`        | 選填。驗證重試次數（預設值：2）       |
+
+### 錯誤處理
+
+如果模型在所有重試後仍無法產生有效的結構化輸出，回應中會包含 `StructuredOutputError`：
+
+```typescript
+if (result.data.info.error?.name === "StructuredOutputError") {
+  console.error("Failed to produce structured output:", result.data.info.error.message)
+  console.error("Attempts:", result.data.info.error.retries)
+}
+```
+
+### 最佳實務
+
+1. **在 Schema 屬性中提供清晰的描述**，幫助模型理解需要擷取的資料
+2. **使用 `required`** 指定哪些欄位必須存在
+3. **保持 Schema 簡潔** — 複雜的巢狀 Schema 可能會讓模型更難正確填充
+4. **設定合適的 `retryCount`** — 對於複雜 Schema 可增加重試次數，對於簡單 Schema 可減少
+
+---
+
+## API
+
+SDK 透過型別安全的用戶端公開所有伺服器 API。
+
+---
+
+### Global
+
+| 方法              | 描述                     | 回應                                 |
+| ----------------- | ------------------------ | ------------------------------------ |
+| `global.health()` | 檢查伺服器健康狀態和版本 | `{ healthy: true, version: string }` |
+
+---
+
+#### 範例
+
+```javascript
+const health = await client.global.health()
+console.log(health.data.version)
+```
+
+---
+
+### App
+
+| 方法           | 描述               | 回應                                        |
+| -------------- | ------------------ | ------------------------------------------- |
+| `app.log()`    | 寫入一筆日誌       | `boolean`                                   |
+| `app.agents()` | 列出所有可用的代理 | <a href={typesUrl}><code>Agent[]</code></a> |
+
+---
+
+#### 範例
+
+```javascript
+// 寫入一筆日誌
+await client.app.log({
+  body: {
+    service: "my-app",
+    level: "info",
+    message: "Operation completed",
+  },
+})
+
+// 列出可用的代理
+const agents = await client.app.agents()
+```
+
+---
+
+### Project
+
+| 方法                | 描述         | 回應                                          |
+| ------------------- | ------------ | --------------------------------------------- |
+| `project.list()`    | 列出所有專案 | <a href={typesUrl}><code>Project[]</code></a> |
+| `project.current()` | 取得當前專案 | <a href={typesUrl}><code>Project</code></a>   |
+
+---
+
+#### 範例
+
+```javascript
+// List all projects
+const projects = await client.project.list()
+
+// Get current project
+const currentProject = await client.project.current()
+```
+
+---
+
+### Path
+
+| 方法         | 描述         | 回應                                     |
+| ------------ | ------------ | ---------------------------------------- |
+| `path.get()` | 取得當前路徑 | <a href={typesUrl}><code>Path</code></a> |
+
+---
+
+#### 範例
+
+```javascript
+// 取得當前路徑資訊
+const pathInfo = await client.path.get()
+```
+
+---
+
+### Config
+
+| 方法                 | 描述                 | 回應                                                                                                  |
+| -------------------- | -------------------- | ----------------------------------------------------------------------------------------------------- |
+| `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()
+
+const { providers, default: defaults } = await client.config.providers()
+```
+
+---
+
+### Sessions
+
+| 方法                                                       | 描述                           | 備註                                                                                                                                                                                           |
+| ---------------------------------------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `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>。支援透過 `body.outputFormat` 使用[結構化輸出](#結構化輸出) |
+| `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
+const session = await client.session.create({
+  body: { title: "My session" },
+})
+
+const sessions = await client.session.list()
+
+// Send a prompt message
+const result = await client.session.prompt({
+  path: { id: session.id },
+  body: {
+    model: { providerID: "anthropic", modelID: "claude-3-5-sonnet-20241022" },
+    parts: [{ type: "text", text: "Hello!" }],
+  },
+})
+
+// Inject context without triggering AI response (useful for plugins)
+await client.session.prompt({
+  path: { id: session.id },
+  body: {
+    noReply: true,
+    parts: [{ type: "text", text: "You are a helpful assistant." }],
+  },
+})
+```
+
+---
+
+### Files
+
+| 方法                      | 描述                 | 回應                                                                                |
+| ------------------------- | -------------------- | ----------------------------------------------------------------------------------- |
+| `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` 支援以下選填的查詢欄位：
+
+- `type`：`"file"` 或 `"directory"`
+- `directory`：覆寫搜尋的專案根目錄
+- `limit`：最大結果數（1–200）
+
+---
+
+#### 範例
+
+```javascript
+// 搜尋和讀取檔案
+const textResults = await client.find.text({
+  query: { pattern: "function.*opencode" },
+})
+
+const files = await client.find.files({
+  query: { query: "*.ts", type: "file" },
+})
+
+const directories = await client.find.files({
+  query: { query: "packages", type: "directory", limit: 20 },
+})
+
+const content = await client.file.read({
+  query: { path: "src/index.ts" },
+})
+```
+
+---
+
+### 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` |
+
+---
+
+#### 範例
+
+```javascript
+// 控制 TUI 介面
+await client.tui.appendPrompt({
+  body: { text: "Add this to prompt" },
+})
+
+await client.tui.showToast({
+  body: { message: "Task completed", variant: "success" },
+})
+```
+
+---
+
+### Auth
+
+| 方法                | 描述         | 回應      |
+| ------------------- | ------------ | --------- |
+| `auth.set({ ... })` | 設定驗證憑證 | `boolean` |
+
+---
+
+#### 範例
+
+```javascript
+await client.auth.set({
+  path: { id: "anthropic" },
+  body: { type: "api", key: "your-api-key" },
+})
+```
+
+---
+
+### Events
+
+| 方法                | 描述                 | 回應                 |
+| ------------------- | -------------------- | -------------------- |
+| `event.subscribe()` | 伺服器傳送的事件串流 | 伺服器傳送的事件串流 |
+
+---
+
+#### 範例
+
+```javascript
+// Listen to real-time events
+const events = await client.event.subscribe()
+for await (const event of events.stream) {
+  console.log("Event:", event.type, event.properties)
+}
+```