docs: CLI docs for current commands and flags (#25399)
This commit is contained in:
OpeOginni
GitHub
parent
1ea6e6cd4b
commit
0d0ec7dc46
18 changed files with 1676 additions and 1413 deletions
|
|
@ -29,16 +29,16 @@ opencode [project]
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | ショート | 説明 |
|
||||
| ------------ | ----------- | ---------------------------------------------------------- |
|
||||
| `--continue` | `-c` | 最後のセッションを続行 |
|
||||
| `--session` | | 続行時にセッションをフォーク (`-s` または `--fork` と併用) |
|
||||
| `--continue` | `--session` | 続行するセッション ID |
|
||||
| `--prompt` | | 使用のプロンプト |
|
||||
| `--model` | `-m` | プロバイダー/モデルの形式で使用するモデル |
|
||||
| `--agent` | | 使用するエージェント |
|
||||
| `--port` | | リッスンするポート |
|
||||
| `--hostname` | | リッスンするホスト名 |
|
||||
| フラグ | ショート | 説明 |
|
||||
| ---------------------------------------- | --------------------------------------- | ---------------------------------------------------------- |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | 最後のセッションを続行 |
|
||||
| <nobr><code>{"--session"}</code></nobr> | | 続行時にセッションをフォーク (`-s` または `--fork` と併用) |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | <nobr><code>{"--session"}</code></nobr> | 続行するセッション ID |
|
||||
| <nobr><code>{"--prompt"}</code></nobr> | | 使用のプロンプト |
|
||||
| <nobr><code>{"--model"}</code></nobr> | `-m` | プロバイダー/モデルの形式で使用するモデル |
|
||||
| <nobr><code>{"--agent"}</code></nobr> | | 使用するエージェント |
|
||||
| <nobr><code>{"--port"}</code></nobr> | | リッスンするポート |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | | リッスンするホスト名 |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -78,10 +78,14 @@ opencode attach http://10.20.30.40:4096
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | ショート | 説明 |
|
||||
| ----------- | -------- | ------------------------------ |
|
||||
| `--dir` | | TUI を開始する作業ディレクトリ |
|
||||
| `--session` | `-s` | 続行するセッション ID |
|
||||
| フラグ | ショート | 説明 |
|
||||
| ---------------------------------------- | -------- | --------------------------------------------------------------------------------- |
|
||||
| <nobr><code>{"--dir"}</code></nobr> | | TUI を開始する作業ディレクトリ |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | 最後のセッションを続行 |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | 続行するセッション ID |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | 続行時にセッションをフォーク（`--continue` または `--session` と使用） |
|
||||
| <nobr><code>{"--password"}</code></nobr> | `-p` | Basic 認証パスワード（デフォルトは `OPENCODE_SERVER_PASSWORD`） |
|
||||
| <nobr><code>{"--username"}</code></nobr> | `-u` | Basic 認証ユーザー名（デフォルトは `OPENCODE_SERVER_USERNAME` または `opencode`） |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -187,10 +191,10 @@ opencode github run
|
|||
|
||||
##### フラグ
|
||||
|
||||
| フラグ | 説明 |
|
||||
| --------- | --------------------------------------------------- |
|
||||
| `--event` | エージェントを実行するための GitHub モック イベント |
|
||||
| `--token` | GitHub 個人アクセストークン |
|
||||
| フラグ | 説明 |
|
||||
| ------------------------------------- | --------------------------------------------------- |
|
||||
| <nobr><code>{"--event"}</code></nobr> | エージェントを実行するための GitHub モック イベント |
|
||||
| <nobr><code>{"--token"}</code></nobr> | GitHub 個人アクセストークン |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -296,10 +300,10 @@ opencode models anthropic
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | 説明 |
|
||||
| ----------- | --------------------------------------------------------------- |
|
||||
| `--refresh` | models.dev からモデルキャッシュを更新します。 |
|
||||
| `--verbose` | より詳細なモデル出力を使用します (コストなどのメタデータを含む) |
|
||||
| フラグ | 説明 |
|
||||
| --------------------------------------- | --------------------------------------------------------------- |
|
||||
| <nobr><code>{"--refresh"}</code></nobr> | models.dev からモデルキャッシュを更新します。 |
|
||||
| <nobr><code>{"--verbose"}</code></nobr> | より詳細なモデル出力を使用します (コストなどのメタデータを含む) |
|
||||
|
||||
`--refresh` フラグを使用して、キャッシュされたモデルリストを更新します。これは、新しいモデルがプロバイダーに追加され、それを OpenCode で確認したい場合に便利です。
|
||||
|
||||
|
|
@ -335,20 +339,25 @@ opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | ショート | 説明 |
|
||||
| ------------ | -------- | ----------------------------------------------------------------------------------------- |
|
||||
| `--command` | | 実行するコマンド。引数には message を使用します。 |
|
||||
| `--continue` | `-c` | 最後のセッションを続行 |
|
||||
| `--session` | `-s` | 続行するセッション ID |
|
||||
| `--fork` | | 続行時にセッションをフォーク (`--continue` または `--session` と併用) |
|
||||
| `--share` | | セッションを共有する |
|
||||
| `--model` | `-m` | プロバイダー/モデルの形式で使用するモデル |
|
||||
| `--agent` | | 使用するエージェント |
|
||||
| `--file` | `-f` | メッセージに添付するファイル |
|
||||
| `--format` | | 形式: デフォルト (フォーマット済み) または json (生の JSON イベント) |
|
||||
| `--title` | | セッションのタイトル (値が指定されていない場合は、切り詰められたプロンプトが使用されます) |
|
||||
| `--attach` | | 実行中の opencode サーバー (http://localhost:4096 など) に接続します。 |
|
||||
| `--port` | | ローカルサーバーのポート (デフォルトはランダムポート) |
|
||||
| フラグ | ショート | 説明 |
|
||||
| ---------------------------------------- | -------- | ----------------------------------------------------------------------------------------- |
|
||||
| <nobr><code>{"--command"}</code></nobr> | | 実行するコマンド。引数には message を使用します。 |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | 最後のセッションを続行 |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | 続行するセッション ID |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | 続行時にセッションをフォーク (`--continue` または `--session` と併用) |
|
||||
| <nobr><code>{"--share"}</code></nobr> | | セッションを共有する |
|
||||
| <nobr><code>{"--model"}</code></nobr> | `-m` | プロバイダー/モデルの形式で使用するモデル |
|
||||
| <nobr><code>{"--agent"}</code></nobr> | | 使用するエージェント |
|
||||
| <nobr><code>{"--file"}</code></nobr> | `-f` | メッセージに添付するファイル |
|
||||
| <nobr><code>{"--format"}</code></nobr> | | 形式: デフォルト (フォーマット済み) または json (生の JSON イベント) |
|
||||
| <nobr><code>{"--title"}</code></nobr> | | セッションのタイトル (値が指定されていない場合は、切り詰められたプロンプトが使用されます) |
|
||||
| <nobr><code>{"--attach"}</code></nobr> | | 実行中の opencode サーバー (http://localhost:4096 など) に接続します。 |
|
||||
| <nobr><code>{"--password"}</code></nobr> | `-p` | Basic 認証パスワード（デフォルトは `OPENCODE_SERVER_PASSWORD`） |
|
||||
| <nobr><code>{"--username"}</code></nobr> | `-u` | Basic 認証ユーザー名（デフォルトは `OPENCODE_SERVER_USERNAME` または `opencode`） |
|
||||
| <nobr><code>{"--dir"}</code></nobr> | | 実行ディレクトリ、またはアタッチ時のリモートサーバー上のパス |
|
||||
| <nobr><code>{"--variant"}</code></nobr> | | モデルバリアント（プロバイダー固有の推論レベル） |
|
||||
| <nobr><code>{"--thinking"}</code></nobr> | | 思考ブロックを表示 |
|
||||
| <nobr><code>{"--port"}</code></nobr> | | ローカルサーバーのポート (デフォルトはランダムポート) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -364,12 +373,12 @@ opencode serve
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | 説明 |
|
||||
| ------------ | --------------------------------------- |
|
||||
| `--port` | リッスンするポート |
|
||||
| `--hostname` | リッスンするホスト名 |
|
||||
| `--mdns` | mDNS 検出を有効にする |
|
||||
| `--cors` | CORS を許可する追加のブラウザーオリジン |
|
||||
| フラグ | 説明 |
|
||||
| ---------------------------------------- | --------------------------------------- |
|
||||
| <nobr><code>{"--port"}</code></nobr> | リッスンするポート |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | リッスンするホスト名 |
|
||||
| <nobr><code>{"--mdns"}</code></nobr> | mDNS 検出を有効にする |
|
||||
| <nobr><code>{"--cors"}</code></nobr> | CORS を許可する追加のブラウザーオリジン |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -393,10 +402,10 @@ opencode session list
|
|||
|
||||
##### フラグ
|
||||
|
||||
| フラグ | ショート | 説明 |
|
||||
| ------------- | -------- | ---------------------------------------- |
|
||||
| `--max-count` | `-n` | 最新のセッションを N 個に制限 |
|
||||
| `--format` | | 出力形式: テーブルまたは json (テーブル) |
|
||||
| フラグ | ショート | 説明 |
|
||||
| ----------------------------------------- | -------- | ---------------------------------------- |
|
||||
| <nobr><code>{"--max-count"}</code></nobr> | `-n` | 最新のセッションを N 個に制限 |
|
||||
| <nobr><code>{"--format"}</code></nobr> | | 出力形式: テーブルまたは json (テーブル) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -410,12 +419,12 @@ opencode stats
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | 説明 |
|
||||
| ----------- | ------------------------------------------------------------------------------------------ |
|
||||
| `--days` | 過去 N 日間の統計を表示 (全期間) |
|
||||
| `--tools` | 表示するツールの数 (すべて) |
|
||||
| `--models` | モデルの使用状況の内訳を表示 (デフォルトでは非表示)。上位 N 件を表示するには数値を渡します |
|
||||
| `--project` | プロジェクトでフィルタリング (全プロジェクト、空文字列: 現在のプロジェクト) |
|
||||
| フラグ | 説明 |
|
||||
| --------------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| <nobr><code>{"--days"}</code></nobr> | 過去 N 日間の統計を表示 (全期間) |
|
||||
| <nobr><code>{"--tools"}</code></nobr> | 表示するツールの数 (すべて) |
|
||||
| <nobr><code>{"--models"}</code></nobr> | モデルの使用状況の内訳を表示 (デフォルトでは非表示)。上位 N 件を表示するには数値を渡します |
|
||||
| <nobr><code>{"--project"}</code></nobr> | プロジェクトでフィルタリング (全プロジェクト、空文字列: 現在のプロジェクト) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -460,12 +469,12 @@ opencode web
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | 説明 |
|
||||
| ------------ | --------------------------------------- |
|
||||
| `--port` | リッスンするポート |
|
||||
| `--hostname` | リッスンするホスト名 |
|
||||
| `--mdns` | mDNS 検出を有効にする |
|
||||
| `--cors` | CORS を許可する追加のブラウザーオリジン |
|
||||
| フラグ | 説明 |
|
||||
| ---------------------------------------- | --------------------------------------- |
|
||||
| <nobr><code>{"--port"}</code></nobr> | リッスンするポート |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | リッスンするホスト名 |
|
||||
| <nobr><code>{"--mdns"}</code></nobr> | mDNS 検出を有効にする |
|
||||
| <nobr><code>{"--cors"}</code></nobr> | CORS を許可する追加のブラウザーオリジン |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -481,11 +490,11 @@ opencode acp
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | 説明 |
|
||||
| ------------ | -------------------- |
|
||||
| `--cwd` | 作業ディレクトリ |
|
||||
| `--port` | リッスンするポート |
|
||||
| `--hostname` | リッスンするホスト名 |
|
||||
| フラグ | 説明 |
|
||||
| ---------------------------------------- | -------------------- |
|
||||
| <nobr><code>{"--cwd"}</code></nobr> | 作業ディレクトリ |
|
||||
| <nobr><code>{"--port"}</code></nobr> | リッスンするポート |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | リッスンするホスト名 |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -499,12 +508,12 @@ opencode uninstall
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | ショート | 説明 |
|
||||
| --------------- | -------- | -------------------------------------------- |
|
||||
| `--keep-config` | `-c` | 構成ファイルを保持する |
|
||||
| `--keep-data` | `-d` | セッションデータとスナップショットを保持する |
|
||||
| `--dry-run` | | 削除せずに削除される内容を表示する |
|
||||
| `--force` | `-f` | 確認プロンプトをスキップする |
|
||||
| フラグ | ショート | 説明 |
|
||||
| ------------------------------------------- | -------- | -------------------------------------------- |
|
||||
| <nobr><code>{"--keep-config"}</code></nobr> | `-c` | 構成ファイルを保持する |
|
||||
| <nobr><code>{"--keep-data"}</code></nobr> | `-d` | セッションデータとスナップショットを保持する |
|
||||
| <nobr><code>{"--dry-run"}</code></nobr> | | 削除せずに削除される内容を表示する |
|
||||
| <nobr><code>{"--force"}</code></nobr> | `-f` | 確認プロンプトをスキップする |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -530,9 +539,9 @@ opencode upgrade v0.1.48
|
|||
|
||||
#### フラグ
|
||||
|
||||
| フラグ | ショート | 説明 |
|
||||
| ---------- | -------- | ------------------------------------------------------ |
|
||||
| `--method` | `-m` | 使用されたインストール方法。curl, npm, pnpm, bun, brew |
|
||||
| フラグ | ショート | 説明 |
|
||||
| -------------------------------------- | -------- | ------------------------------------------------------ |
|
||||
| <nobr><code>{"--method"}</code></nobr> | `-m` | 使用されたインストール方法。curl, npm, pnpm, bun, brew |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -540,12 +549,12 @@ opencode upgrade v0.1.48
|
|||
|
||||
opencode CLI は次のグローバルフラグを受け取ります。
|
||||
|
||||
| フラグ | ショート | 説明 |
|
||||
| -------------- | -------- | ------------------------------------- |
|
||||
| `--help` | `-h` | ヘルプを表示 |
|
||||
| `--version` | `-v` | バージョン番号を出力 |
|
||||
| `--print-logs` | | ログを標準エラー出力に出力 |
|
||||
| `--log-level` | | ログレベル (DEBUG、INFO、WARN、ERROR) |
|
||||
| フラグ | ショート | 説明 |
|
||||
| ------------------------------------------ | -------- | ------------------------------------- |
|
||||
| <nobr><code>{"--help"}</code></nobr> | `-h` | ヘルプを表示 |
|
||||
| <nobr><code>{"--version"}</code></nobr> | `-v` | バージョン番号を出力 |
|
||||
| <nobr><code>{"--print-logs"}</code></nobr> | | ログを標準エラー出力に出力 |
|
||||
| <nobr><code>{"--log-level"}</code></nobr> | | ログレベル (DEBUG、INFO、WARN、ERROR) |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue