604 lines
22 KiB
Plaintext
604 lines
22 KiB
Plaintext
---
|
|
title: CLI
|
|
description: OpenCode CLI のオプションとコマンド。
|
|
---
|
|
|
|
import { Tabs, TabItem } from "@astrojs/starlight/components"
|
|
|
|
OpenCode CLI は、引数なしで実行すると、デフォルトで [TUI](/docs/tui) を開始します。
|
|
|
|
```bash
|
|
opencode
|
|
```
|
|
|
|
ただし、このページに記載されているようにコマンドも受け入れます。これにより、OpenCode をプログラム的に操作できるようになります。
|
|
|
|
```bash
|
|
opencode run "Explain how closures work in JavaScript"
|
|
```
|
|
|
|
---
|
|
|
|
### トゥイ
|
|
|
|
OpenCode terminal ユーザー インターフェイスを開始します。
|
|
|
|
```bash
|
|
opencode [project]
|
|
```
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | ショート | 説明 |
|
|
| ------------ | -------- | --------------------------------------------------------------------- |
|
|
| `--continue` | `-c` | 最後のセッションを続行 |
|
|
| `--fork` | | 続行時にセッションをフォーク (`--continue` または `--session` と併用) |
|
|
| `--session` | `-s` | 続行するセッション ID |
|
|
| `--prompt` | | 使用のプロンプト |
|
|
| `--model` | `-m` | プロバイダー/モデルの形式で使用するモデル |
|
|
| `--agent` | | 使用するエージェント |
|
|
| `--port` | | リッスンするポート |
|
|
| `--hostname` | | リッスンするホスト名 |
|
|
|
|
---
|
|
|
|
## コマンド
|
|
|
|
OpenCode CLI には次のコマンドもあります。
|
|
|
|
---
|
|
|
|
### エージェント
|
|
|
|
OpenCode のエージェントを管理します。
|
|
|
|
```bash
|
|
opencode agent [command]
|
|
```
|
|
|
|
---
|
|
|
|
### 付ける
|
|
|
|
`serve` または `web` コマンドを使用して起動された、すでに実行中の OpenCode バックエンド サーバーにterminal を接続します。
|
|
|
|
```bash
|
|
opencode attach [url]
|
|
```
|
|
|
|
これにより、リモート OpenCode バックエンドで TUI を使用できるようになります。例えば：
|
|
|
|
```bash
|
|
# Start the backend server for web/mobile access
|
|
opencode web --port 4096 --hostname 0.0.0.0
|
|
|
|
# In another terminal, attach the TUI to the running backend
|
|
opencode attach http://10.20.30.40:4096
|
|
```
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | ショート | 説明 |
|
|
| ----------- | -------- | ------------------------------ |
|
|
| `--dir` | | TUI を開始する作業ディレクトリ |
|
|
| `--session` | `-s` | 続行するセッション ID |
|
|
|
|
---
|
|
|
|
#### 作成する
|
|
|
|
カスタム構成で新しいエージェントを作成します。
|
|
|
|
```bash
|
|
opencode agent create
|
|
```
|
|
|
|
このコマンドは、カスタム システム プロンプトとツール構成を使用して新しいエージェントを作成する手順を示します。
|
|
|
|
---
|
|
|
|
#### リスト
|
|
|
|
利用可能なエージェントをすべてリストします。
|
|
|
|
```bash
|
|
opencode agent list
|
|
```
|
|
|
|
---
|
|
|
|
### 認証
|
|
|
|
プロバイダーの資格情報とログインを管理するコマンド。
|
|
|
|
```bash
|
|
opencode auth [command]
|
|
```
|
|
|
|
---
|
|
|
|
#### ログイン
|
|
|
|
OpenCode は [Models.dev](https://models.dev) のプロバイダー リストを利用しているため、`opencode auth login` を使用して、使用したいプロバイダーの API キーを構成できます。これは`~/.local/share/opencode/auth.json`に保存されます。
|
|
|
|
```bash
|
|
opencode auth login
|
|
```
|
|
|
|
OpenCode が起動すると、認証情報ファイルからプロバイダーがロードされます。また、環境またはプロジェクト内の `.env` ファイルで定義されたキーがあるかどうかも確認します。
|
|
|
|
---
|
|
|
|
#### リスト
|
|
|
|
認証情報ファイルに保存されているすべての認証されたプロバイダーをリストします。
|
|
|
|
```bash
|
|
opencode auth list
|
|
```
|
|
|
|
またはショートバージョン。
|
|
|
|
```bash
|
|
opencode auth ls
|
|
```
|
|
|
|
---
|
|
|
|
#### ログアウト
|
|
|
|
資格情報ファイルからプロバイダーをクリアすることで、プロバイダーからログアウトします。
|
|
|
|
```bash
|
|
opencode auth logout
|
|
```
|
|
|
|
---
|
|
|
|
### GitHub
|
|
|
|
リポジトリ自動化のための GitHub エージェントを管理します。
|
|
|
|
```bash
|
|
opencode github [command]
|
|
```
|
|
|
|
---
|
|
|
|
#### インストール
|
|
|
|
GitHub エージェントをリポジトリにインストールします。
|
|
|
|
```bash
|
|
opencode github install
|
|
```
|
|
|
|
これにより、必要な GitHub Actions ワークフローが設定され、構成プロセスがガイドされます。 [詳細はこちら](/docs/github)。
|
|
|
|
---
|
|
|
|
#### 走る
|
|
|
|
GitHub エージェントを実行します。これは通常、GitHub Actions で使用されます。
|
|
|
|
```bash
|
|
opencode github run
|
|
```
|
|
|
|
##### フラグ
|
|
|
|
| 旗 | 説明 |
|
|
| --------- | --------------------------------------------------- |
|
|
| `--event` | エージェントを実行するための GitHub モック イベント |
|
|
| `--token` | GitHub個人アクセストークン |
|
|
|
|
---
|
|
|
|
### mcp
|
|
|
|
モデル コンテキスト プロトコル サーバーを管理します。
|
|
|
|
```bash
|
|
opencode mcp [command]
|
|
```
|
|
|
|
---
|
|
|
|
#### 追加
|
|
|
|
MCP サーバーを構成に追加します。
|
|
|
|
```bash
|
|
opencode mcp add
|
|
```
|
|
|
|
このコマンドは、ローカルまたはリモートの MCP サーバーを追加する手順を示します。
|
|
|
|
---
|
|
|
|
#### リスト
|
|
|
|
構成されているすべての MCP サーバーとその接続ステータスをリストします。
|
|
|
|
```bash
|
|
opencode mcp list
|
|
```
|
|
|
|
または、短いバージョンを使用してください。
|
|
|
|
```bash
|
|
opencode mcp ls
|
|
```
|
|
|
|
---
|
|
|
|
#### 認証
|
|
|
|
OAuth 対応の MCP サーバーで認証します。
|
|
|
|
```bash
|
|
opencode mcp auth [name]
|
|
```
|
|
|
|
サーバー名を指定しない場合は、利用可能な OAuth 対応サーバーから選択するように求められます。
|
|
|
|
OAuth 対応サーバーとその認証ステータスを一覧表示することもできます。
|
|
|
|
```bash
|
|
opencode mcp auth list
|
|
```
|
|
|
|
または、短いバージョンを使用してください。
|
|
|
|
```bash
|
|
opencode mcp auth ls
|
|
```
|
|
|
|
---
|
|
|
|
#### ログアウト
|
|
|
|
MCP サーバーの OAuth 資格情報を削除します。
|
|
|
|
```bash
|
|
opencode mcp logout [name]
|
|
```
|
|
|
|
---
|
|
|
|
#### デバッグ
|
|
|
|
MCP サーバーの OAuth 接続の問題をデバッグします。
|
|
|
|
```bash
|
|
opencode mcp debug <name>
|
|
```
|
|
|
|
---
|
|
|
|
### モデル
|
|
|
|
構成されたプロバイダーから利用可能なすべてのモデルをリストします。
|
|
|
|
```bash
|
|
opencode models [provider]
|
|
```
|
|
|
|
このコマンドは、構成されたプロバイダー全体で利用可能なすべてのモデルを `provider/model` の形式で表示します。
|
|
|
|
これは、config](/docs/config/) で使用する正確なモデル名を把握するのに役立ちます。
|
|
|
|
オプションでプロバイダー ID を渡して、そのプロバイダーによってモデルをフィルターできます。
|
|
|
|
```bash
|
|
opencode models anthropic
|
|
```
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | 説明 |
|
|
| ----------- | --------------------------------------------------------------- |
|
|
| `--refresh` | models.dev からモデル キャッシュを更新します。 |
|
|
| `--verbose` | より詳細なモデル出力を使用します (コストなどのメタデータを含む) |
|
|
|
|
`--refresh` フラグを使用して、キャッシュされたモデル リストを更新します。これは、新しいモデルがプロバイダーに追加され、それを OpenCode で確認したい場合に便利です。
|
|
|
|
```bash
|
|
opencode models --refresh
|
|
```
|
|
|
|
---
|
|
|
|
### 走る
|
|
|
|
プロンプトを直接渡して、非対話モードでopencodeを実行します。
|
|
|
|
```bash
|
|
opencode run [message..]
|
|
```
|
|
|
|
これは、スクリプト作成、自動化、または完全な TUI を起動せずに迅速な回答が必要な場合に便利です。例えば。
|
|
|
|
```bash "opencode run"
|
|
opencode run Explain the use of context in Go
|
|
```
|
|
|
|
実行中の `opencode serve` インスタンスにアタッチして、実行ごとの MCP サーバーのコールド ブート時間を回避することもできます。
|
|
|
|
```bash
|
|
# Start a headless server in one terminal
|
|
opencode serve
|
|
|
|
# In another terminal, run commands that attach to it
|
|
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
|
|
```
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | ショート | 説明 |
|
|
| ------------ | -------- | ----------------------------------------------------------------------------------------- |
|
|
| `--command` | | 実行するコマンド。引数には message を使用します。 |
|
|
| `--continue` | `-c` | 最後のセッションを続行 |
|
|
| `--fork` | | 続行時にセッションをフォーク (`--continue` または `--session` と併用) |
|
|
| `--session` | `-s` | 続行するセッション ID |
|
|
| `--share` | | セッションを共有する |
|
|
| `--model` | `-m` | プロバイダー/モデルの形式で使用するモデル |
|
|
| `--agent` | | 使用するエージェント |
|
|
| `--file` | `-f` | メッセージに添付するファイル |
|
|
| `--format` | | 形式: デフォルト (フォーマット済み) または json (生の JSON イベント) |
|
|
| `--title` | | セッションのタイトル (値が指定されていない場合は、切り詰められたプロンプトが使用されます) |
|
|
| `--attach` | | 実行中のopencodeサーバー (http://localhost:4096 など) に接続します。 |
|
|
| `--port` | | ローカルサーバーのポート (デフォルトはランダムポート) |
|
|
|
|
---
|
|
|
|
### 仕える
|
|
|
|
API アクセスのためにヘッドレス OpenCode サーバーを起動します。完全な HTTP インターフェイスについては、[server docs](/docs/server) を確認してください。
|
|
|
|
```bash
|
|
opencode serve
|
|
```
|
|
|
|
これにより、TUI インターフェイスを使用せずにopencode機能への API アクセスを提供する HTTP サーバーが起動します。 `OPENCODE_SERVER_PASSWORD` を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは `opencode`)。
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | 説明 |
|
|
| ------------ | --------------------------------------- |
|
|
| `--port` | リッスンするポート |
|
|
| `--hostname` | リッスンするホスト名 |
|
|
| `--mdns` | mDNS 検出を有効にする |
|
|
| `--cors` | CORS を許可する追加のブラウザーオリジン |
|
|
|
|
---
|
|
|
|
### セッション
|
|
|
|
OpenCode セッションを管理します。
|
|
|
|
```bash
|
|
opencode session [command]
|
|
```
|
|
|
|
---
|
|
|
|
#### リスト
|
|
|
|
すべての OpenCode セッションをリストします。
|
|
|
|
```bash
|
|
opencode session list
|
|
```
|
|
|
|
##### フラグ
|
|
|
|
| 旗 | ショート | 説明 |
|
|
| ------------- | -------- | ---------------------------------------- |
|
|
| `--max-count` | `-n` | 最新のセッションを N 個に制限 |
|
|
| `--format` | | 出力形式: テーブルまたは json (テーブル) |
|
|
|
|
---
|
|
|
|
### 統計
|
|
|
|
OpenCode セッションのトークンの使用状況とコストの統計を表示します。
|
|
|
|
```bash
|
|
opencode stats
|
|
```
|
|
|
|
#### フラグ
|
|
|
|
| Flag | Description |
|
|
| ----------- | --------------------------------------------------------------------------- |
|
|
| `--days` | Show stats for the last N days (all time) |
|
|
| `--tools` | Number of tools to show (all) |
|
|
| `--models` | Show model usage breakdown (hidden by default). Pass a number to show top N |
|
|
| `--project` | Filter by project (all projects, empty string: current project) |
|
|
|
|
---
|
|
|
|
### 輸出
|
|
|
|
セッションデータをJSONとしてエクスポートします。
|
|
|
|
```bash
|
|
opencode export [sessionID]
|
|
```
|
|
|
|
セッション ID を指定しない場合は、利用可能なセッションから選択するように求められます。
|
|
|
|
---
|
|
|
|
### 輸入
|
|
|
|
JSON ファイルまたは OpenCode 共有 URL からセッション データをインポートします。
|
|
|
|
```bash
|
|
opencode import <file>
|
|
```
|
|
|
|
ローカル ファイルまたは OpenCode 共有 URL からインポートできます。
|
|
|
|
```bash
|
|
opencode import session.json
|
|
opencode import https://opncd.ai/s/abc123
|
|
```
|
|
|
|
---
|
|
|
|
### ウェブ
|
|
|
|
Web インターフェイスを使用してヘッドレス OpenCode サーバーを起動します。
|
|
|
|
```bash
|
|
opencode web
|
|
```
|
|
|
|
これにより、HTTP サーバーが起動し、Web ブラウザが開き、Web インターフェイスを通じて OpenCode にアクセスします。 `OPENCODE_SERVER_PASSWORD` を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは `opencode`)。
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | 説明 |
|
|
| ------------ | --------------------------------------- |
|
|
| `--port` | リッスンするポート |
|
|
| `--hostname` | リッスンするホスト名 |
|
|
| `--mdns` | mDNS 検出を有効にする |
|
|
| `--cors` | CORS を許可する追加のブラウザーオリジン |
|
|
|
|
---
|
|
|
|
### acp
|
|
|
|
ACP (エージェント クライアント プロトコル) サーバーを起動します。
|
|
|
|
```bash
|
|
opencode acp
|
|
```
|
|
|
|
このコマンドは、nd-JSON を使用して stdin/stdout 経由で通信する ACP サーバーを起動します。
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | 説明 |
|
|
| ------------ | -------------------- |
|
|
| `--cwd` | 作業ディレクトリ |
|
|
| `--port` | リッスンするポート |
|
|
| `--hostname` | リッスンするホスト名 |
|
|
|
|
---
|
|
|
|
### アンインストールする
|
|
|
|
OpenCode をアンインストールし、関連ファイルをすべて削除します。
|
|
|
|
```bash
|
|
opencode uninstall
|
|
```
|
|
|
|
#### フラグ
|
|
|
|
| Flag | Short | Description |
|
|
| --------------- | ----- | ------------------------------------------- |
|
|
| `--keep-config` | `-c` | Keep configuration files |
|
|
| `--keep-data` | `-d` | Keep session data and snapshots |
|
|
| `--dry-run` | | Show what would be removed without removing |
|
|
| `--force` | `-f` | Skip confirmation prompts |
|
|
|
|
---
|
|
|
|
### アップグレード
|
|
|
|
opencodeを最新バージョンまたは特定のバージョンに更新します。
|
|
|
|
```bash
|
|
opencode upgrade [target]
|
|
```
|
|
|
|
最新バージョンにアップグレードするには。
|
|
|
|
```bash
|
|
opencode upgrade
|
|
```
|
|
|
|
特定のバージョンにアップグレードするには。
|
|
|
|
```bash
|
|
opencode upgrade v0.1.48
|
|
```
|
|
|
|
#### フラグ
|
|
|
|
| 旗 | ショート | 説明 |
|
|
| ---------- | -------- | --------------------------------------------------------- |
|
|
| `--method` | `-m` | 使用されたインストール方法。カール、npm、pnpm、バン、醸造 |
|
|
|
|
---
|
|
|
|
## グローバルフラグ
|
|
|
|
opencode CLI は次のグローバル フラグを受け取ります。
|
|
|
|
| 旗 | ショート | 説明 |
|
|
| -------------- | -------- | -------------------------------------- |
|
|
| `--help` | `-h` | ヘルプを表示 |
|
|
| `--version` | `-v` | バージョン番号を出力 |
|
|
| `--print-logs` | | ログを標準エラー出力に出力 |
|
|
| `--log-level` | | ログ レベル (DEBUG、INFO、WARN、ERROR) |
|
|
|
|
---
|
|
|
|
## 環境変数
|
|
|
|
OpenCode は環境変数を使用して構成できます。
|
|
|
|
| 変数 | タイプ | 説明 |
|
|
| ------------------------------------- | -------- | ------------------------------------------------------------------- |
|
|
| `OPENCODE_AUTO_SHARE` | ブール値 | セッションを自動的に共有する |
|
|
| `OPENCODE_GIT_BASH_PATH` | 文字列 | Windows 上で実行可能な Git Bash へのパス |
|
|
| `OPENCODE_CONFIG` | 文字列 | 構成ファイルへのパス |
|
|
| `OPENCODE_CONFIG_DIR` | 文字列 | config ディレクトリへのパス |
|
|
| `OPENCODE_CONFIG_CONTENT` | 文字列 | インライン JSON 構成コンテンツ |
|
|
| `OPENCODE_DISABLE_AUTOUPDATE` | ブール値 | 自動更新チェックを無効にする |
|
|
| `OPENCODE_DISABLE_PRUNE` | ブール値 | 古いデータのプルーニングを無効にする |
|
|
| `OPENCODE_DISABLE_TERMINAL_TITLE` | ブール値 | terminal titleの自動更新を無効にする |
|
|
| `OPENCODE_PERMISSION` | 文字列 | インライン化された json 権限設定 |
|
|
| `OPENCODE_DISABLE_DEFAULT_PLUGINS` | ブール値 | デフォルトのプラグインを無効にする |
|
|
| `OPENCODE_DISABLE_LSP_DOWNLOAD` | ブール値 | LSP サーバーの自動ダウンロードを無効にする |
|
|
| `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | ブール値 | 実験モデルを有効にする |
|
|
| `OPENCODE_DISABLE_AUTOCOMPACT` | ブール値 | 自動コンテキスト圧縮を無効にする |
|
|
| `OPENCODE_DISABLE_CLAUDE_CODE` | ブール値 | `.claude` からの読み取りを無効にする (プロンプト + スキル) |
|
|
| `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | ブール値 | `~/.claude/CLAUDE.md` の読み取りを無効にする |
|
|
| `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | ブール値 | `.claude/skills` のロードを無効にする |
|
|
| `OPENCODE_DISABLE_MODELS_FETCH` | ブール値 | リモート ソースからのモデルの取得を無効にする |
|
|
| `OPENCODE_FAKE_VCS` | 文字列 | テスト目的の偽の VCS プロバイダー |
|
|
| `OPENCODE_DISABLE_FILETIME_CHECK` | ブール値 | 最適化のためにファイル時間チェックを無効にする |
|
|
| `OPENCODE_CLIENT` | 文字列 | クライアント識別子 (デフォルトは `cli`) |
|
|
| `OPENCODE_ENABLE_EXA` | ブール値 | Exa Web 検索ツールを有効にする |
|
|
| `OPENCODE_SERVER_PASSWORD` | 文字列 | `serve`/`web` の基本認証を有効にする |
|
|
| `OPENCODE_SERVER_USERNAME` | 文字列 | 基本認証ユーザー名 (デフォルト `opencode`) をオーバーライドします。 |
|
|
| `OPENCODE_MODELS_URL` | 文字列 | モデル設定を取得するためのカスタム URL |
|
|
|
|
---
|
|
|
|
### 実験的
|
|
|
|
これらの環境変数により、変更または削除される可能性のある実験的な機能が有効になります。
|
|
|
|
| 変数 | タイプ | 説明 |
|
|
| ----------------------------------------------- | -------- | ------------------------------------------------ |
|
|
| `OPENCODE_EXPERIMENTAL` | ブール値 | すべての実験的機能を有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_ICON_DISCOVERY` | ブール値 | アイコン検出を有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT` | ブール値 | TUI で選択時のコピーを無効にする |
|
|
| `OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS` | 番号 | bash コマンドのデフォルトのタイムアウト (ミリ秒) |
|
|
| `OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX` | 番号 | LLM 応答の最大出力トークン |
|
|
| `OPENCODE_EXPERIMENTAL_FILEWATCHER` | ブール値 | ディレクトリ全体のファイル監視を有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_OXFMT` | ブール値 | oxfmt フォーマッタを有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_LSP_TOOL` | ブール値 | 実験的な LSP ツールを有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER` | ブール値 | ファイルウォッチャーを無効にする |
|
|
| `OPENCODE_EXPERIMENTAL_EXA` | ブール値 | 実験的な Exa 機能を有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_LSP_TY` | ブール値 | 実験的な LSP タイプ チェックを有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_MARKDOWN` | ブール値 | 試験的なMarkdown機能を有効にする |
|
|
| `OPENCODE_EXPERIMENTAL_PLAN_MODE` | ブール値 | プランモードを有効にする |
|