@neurocode-ai/web 1.18.8

package/src/content/docs/ja/rules.mdx

@@ -0,0 +1,179 @@
+---
+title: ルール
+description: OpenCode のカスタム命令を設定します。
+---
+
+`AGENTS.md` ファイルを作成することで、OpenCode にカスタム命令を提供できます。これは Cursor のルールと似ています。これには、特定のプロジェクトに合わせて LLM の動作をカスタマイズするために 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 を使用して Web から命令をロードすることもできます。
+
+```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` のファイル参照を自動的に解析しませんが、次の 2 つの方法で同様の機能を実現できます。
+
+### `opencode.json` の使用
+
+推奨されるアプローチは、`instructions` の `opencode.json` フィールドを使用することです。
+
+```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
+モノリポジトリまたは共有標準を使用するプロジェクトの場合、グロブパターン (`opencode.json` など) で `packages/*/AGENTS.md` を使用する方が、手動で指示するよりも保守しやすくなります。
+:::

package/src/content/docs/ja/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) をご覧ください。たとえば、コミュニティによって構築された [projects](/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` | カスタムフェッチの実装                   | `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)
+}
+```
+
+---
+
+## 構造化出力
+
+`format` を JSON スキーマで指定することで、モデルから構造化された JSON 出力をリクエストできます。モデルは `StructuredOutput` ツールを使用して、スキーマに一致する検証済み 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` | 提供されたスキーマに一致する検証済み JSON を返します |
+
+### JSON スキーマフォーマット
+
+`type: 'json_schema'` を使用する場合は、以下を指定します:
+
+| フィールド   | タイプ          | 説明                                               |
+| ------------ | --------------- | -------------------------------------------------- |
+| `type`       | `'json_schema'` | 必須。JSON スキーマモードを指定します              |
+| `schema`     | `object`        | 必須。出力構造を定義する JSON スキーマオブジェクト |
+| `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. **明確な説明を提供する**: モデルが抽出するデータを理解できるように、スキーマプロパティに明確な説明を提供します
+2. **`required` を使用する**: 存在する必要があるフィールドを指定します
+3. **スキーマを焦点を絞ったものにする**: 複雑なネストされたスキーマは、モデルが正しく入力するのが難しい場合があります
+4. **適切な `retryCount` を設定する**: 複雑なスキーマの場合は増やし、単純なスキーマの場合は減らします
+
+---
+
+## 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
+// Write a log entry
+await client.app.log({
+  body: {
+    service: "my-app",
+    level: "info",
+    message: "Operation completed",
+  },
+})
+
+// List available agents
+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
+// Get current path information
+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 })`                            | シェルコマンドを実行する                | 戻り値 <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 })`    | Search for text in files           | Array of match objects with `path`, `lines`, `line_number`, `absolute_offset`, `submatches` |
+| `find.files({ query })`   | Find files and directories by name | `string[]` (paths)                                                                          |
+| `find.symbols({ query })` | Find workspace symbols             | <a href={typesUrl}><code>Symbol[]</code></a>                                                |
+| `file.read({ query })`    | Read a file                        | `{ type: "raw" \| "patch", content: string }`                                               |
+| `file.status({ query? })` | Get status for tracked files       | <a href={typesUrl}><code>File[]</code></a>                                                  |
+
+`find.files` は、いくつかのオプションのクエリフィールドをサポートしています。
+
+- `type`: `"file"` または `"directory"`
+- `directory`: 検索用のプロジェクトルートをオーバーライドします。
+- `limit`: 最大結果 (1 ～ 200)
+
+---
+
+#### 例
+
+```javascript
+// Search and read files
+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 })`      | トースト通知を表示               | `boolean` |
+
+---
+
+#### 例
+
+```javascript
+// Control TUI interface
+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)
+}
+```