chore: generate
This commit is contained in:
opencode-agent[bot]
@@ -37,13 +37,13 @@ const { client } = await createOpencode()
|
||||
|
||||
#### オプション
|
||||
|
||||
|オプション |タイプ |説明 |デフォルト |
|
||||
| ---------- | ------------- | ------------------------------ | ----------- |
|
||||
| `hostname` | `string` |サーバーのホスト名 |うーん
|
||||
| `port` | `number` |サーバーポート |うーん
|
||||
| `signal` | `AbortSignal` |キャンセルのためのアボート信号 |うーん
|
||||
| `timeout` | `number` |サーバー起動のタイムアウト (ミリ秒) |うーん
|
||||
| `config` | `Config` |構成オブジェクト |うーん
|
||||
| オプション | タイプ | 説明 | デフォルト |
|
||||
| ---------- | ------------- | ----------------------------------- | ---------- |
|
||||
| `hostname` | `string` | サーバーのホスト名 | うーん |
|
||||
| `port` | `number` | サーバーポート | うーん |
|
||||
| `signal` | `AbortSignal` | キャンセルのためのアボート信号 | うーん |
|
||||
| `timeout` | `number` | サーバー起動のタイムアウト (ミリ秒) | うーん |
|
||||
| `config` | `Config` | 構成オブジェクト | うーん |
|
||||
|
||||
---
|
||||
|
||||
@@ -81,13 +81,13 @@ const client = createOpencodeClient({
|
||||
|
||||
#### オプション
|
||||
|
||||
|オプション |タイプ |説明 |デフォルト |
|
||||
| --------------- | ---------- | -------------------------------- | ----------------------- |
|
||||
| `baseUrl` | `string` |サーバーの URL |うーん
|
||||
| `fetch` | `function` |カスタムフェッチの実装 |うーん
|
||||
| `parseAs` | `string` |応答解析方法 |うーん
|
||||
| `responseStyle` | `string` |戻り値のスタイル: `data` または `fields` |認証済み
|
||||
| `throwOnError` | `boolean` | | を返す代わりにエラーをスローします。うーん
|
||||
| オプション | タイプ | 説明 | デフォルト |
|
||||
| --------------- | ---------- | ---------------------------------------- | ------------------------------------------ |
|
||||
| `baseUrl` | `string` | サーバーの URL | うーん |
|
||||
| `fetch` | `function` | カスタムフェッチの実装 | うーん |
|
||||
| `parseAs` | `string` | 応答解析方法 | うーん |
|
||||
| `responseStyle` | `string` | 戻り値のスタイル: `data` または `fields` | 認証済み |
|
||||
| `throwOnError` | `boolean` | | を返す代わりにエラーをスローします。うーん |
|
||||
|
||||
---
|
||||
|
||||
@@ -125,9 +125,9 @@ SDK は、タイプセーフなクライアントを通じてすべてのサー
|
||||
|
||||
### グローバル
|
||||
|
||||
|方法 |説明 |応答 |
|
||||
| ----------------- | ------------------------------- | ------------------------------------ |
|
||||
| `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>プロバイダ[]</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 } }` |
|
||||
|
||||
---
|
||||
|
||||
@@ -226,27 +226,27 @@ const { providers, default: defaults } = await client.config.providers()
|
||||
|
||||
### セッション
|
||||
|
||||
|方法 |説明 |メモ |
|
||||
| ---------------------------------------------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `session.list()` |セッションをリストする |戻り値 <a href={typesUrl}><code>セッション[]</code></a> |
|
||||
| `session.get({ path })` |セッションを取得 |戻り値 <a href={typesUrl}><code>セッション</code></a> |
|
||||
| `session.children({ path })` |子セッションをリストする |戻り値 <a href={typesUrl}><code>セッション[]</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.init({ path, body })` |アプリを分析して `AGENTS.md` を作成する |戻り値 `boolean` |
|
||||
| `session.abort({ path })` |実行中のセッションを中止する |戻り値 `boolean` |
|
||||
| `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>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 })` |シェルコマンドを実行する |戻り値 <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` |
|
||||
| 方法 | 説明 | メモ |
|
||||
| ---------------------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `session.list()` | セッションをリストする | 戻り値 <a href={typesUrl}><code>セッション[]</code></a> |
|
||||
| `session.get({ path })` | セッションを取得 | 戻り値 <a href={typesUrl}><code>セッション</code></a> |
|
||||
| `session.children({ path })` | 子セッションをリストする | 戻り値 <a href={typesUrl}><code>セッション[]</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.init({ path, body })` | アプリを分析して `AGENTS.md` を作成する | 戻り値 `boolean` |
|
||||
| `session.abort({ path })` | 実行中のセッションを中止する | 戻り値 `boolean` |
|
||||
| `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>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 })` | シェルコマンドを実行する | 戻り値 <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` |
|
||||
|
||||
---
|
||||
|
||||
@@ -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.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` |
|
||||
| 方法 | 説明 | 応答 |
|
||||
| ------------------------------ | -------------------------------- | --------- |
|
||||
| `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` |
|
||||
|
||||
---
|
||||
|
||||
@@ -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