CLI リファレンス
コマンドクイックリファレンス
| コマンド | 用途 |
|---|---|
opencode tui | ターミナルユーザーインターフェースを起動 |
opencode run | プログラム的にプロンプトを実行 |
opencode serve | ヘッドレスバックエンドサーバーを起動 |
opencode web | Web インターフェース付きバックエンドサーバーを起動 |
opencode attach | 実行中のバックエンドサーバーに接続 |
opencode auth | AI Provider の認証情報を管理 |
opencode models | 利用可能な AI モデルをリスト表示 |
opencode session | 会話セッションを管理 |
opencode github | GitHub エージェントを管理 |
opencode pr | GitHub PR を取得してチェックアウト |
opencode export | 会話データをエクスポート |
opencode import | データをインポート |
opencode stats | 使用統計を表示 |
opencode init | プロジェクトを初期化し AGENTS.md を作成 |
コアインタラクションコマンド
opencode tui
OpenCode ターミナルユーザーインターフェース(TUI)を起動します。これは opencode を引数なしで実行した時のデフォルト動作です。
構文
opencode tui [options]
例
# カレントディレクトリで TUI を起動
opencode tui
# TUI を起動(デフォルト動作)
opencode
ユースケース
- インタラクティブ開発:AI アシスタンスを使用した日常のコーディングタスク
- プロジェクト探索:馴染みのないコードベースのナビゲーションと理解
- リアルタイム協働:複雑な問題に AI と共に取り組む
opencode run
TUI に入ることなく、プログラム的にプロンプトを実行します。スクリプトや自動化に最適です。
構文
opencode run "<prompt>" [options]
例
# 単一のプロンプトを実行
opencode run "Explain how closures work in JavaScript"
# 特定のモデルを使用
opencode run "Refactor this function" --model anthropic/claude-3.5-sonnet
# 前回のセッションから続行
opencode run "Continue the refactoring" --continue
ユースケース
- CI/CD 統合:自動化されたコードレビューと提案
- バッチ処理:スクリプト内で複数のプロンプトを処理
- クイッククエリ:TUI を開かずに即座に答えを取得
opencode serve
ターミナルインターフェースなしで API アクセスを提供するヘッドレス OpenCode バックエンドサーバーを起動します。
構文
opencode serve [options]
例
# バックエンドサーバーを起動
opencode serve
# カスタムポートでサーバーを起動
opencode serve --port 4096
ユースケース
- リモートアクセス:サーバー上で OpenCode を実行し、クライアントから接続
- チーム協働:単一の OpenCode インスタンスを共有
- 統合開発:カスタムフロントエンドやツールを構築
opencode web
Web インターフェース付きのバックエンドサーバーを起動し、ブラウザから OpenCode にアクセスできるようにします。
構文
opencode web [options]
オプション
| オプション | 説明 |
|---|---|
--port | リッスンするポート(デフォルト値は状況により異なる) |
--hostname | バインドするホスト名 |
例
# Web サーバーを起動
opencode web
# 特定のポートとホスト名で起動
opencode web --port 4096 --hostname 0.0.0.0
# 外部アクセスを許可
opencode web --hostname 0.0.0.0
ユースケース
- モバイルアクセス:タブレットやスマートフォンから OpenCode を使用
- ブラウザ優先:ターミナルではなく Web UI で作業
- 画面共有:ペアプログラミング時に共有しやすい
opencode attach
既に実行中の OpenCode バックエンドサーバー(serve または web で起動)に接続します。
構文
opencode attach [url] [options]
オプション
| オプション | 説明 |
|---|---|
--dir | TUI を起動する作業ディレクトリ |
--session, -s | 続行するセッション ID |
例
# リモートサーバーに接続
opencode attach http://10.20.30.40:4096
# 接続して作業ディレクトリを指定
opencode attach http://server:4096 --dir /path/to/project
# 接続して特定のセッションを続行
opencode attach http://server:4096 --session abc123
ユースケース
- リモート開発:強力なサーバー上で実行される OpenCode に接続
- セッション共有:複数のユーザーが同じバックエンドに接続
- 再接続:ネットワーク中断後に作業を再開
認証管理
opencode auth
AI Provider の認証情報と認証を管理します。
構文
opencode auth [command]
サブコマンド
opencode auth login
Models.dev がサポートする AI Provider の API キーを設定します。認証情報は ~/.local/share/opencode/auth.json に保存されます。
例
# インタラクティブ認証を開始
opencode auth login
# 特定の Provider で認証
opencode auth login --provider anthropic
ユースケース
- 初期セットアップ:初めて使用する時に OpenCode を設定
- Provider 切り替え:新しい AI Provider の認証情報を追加
- キーローテーション:セキュリティのために API キーを更新
モデル管理
opencode models
設定済み Provider の利用可能なすべてのモデルをリスト表示します。モデルは provider/model 形式で表示されます。
構文
opencode models [provider]
例
# すべての利用可能なモデルをリスト表示
opencode models
# 特定の Provider のモデルをリスト表示
opencode models anthropic
# grep でフィルタリング
opencode models | grep claude
ユースケース
- モデル発見:用途に応じた利用可能なモデルを見つける
- Provider 比較:各 Provider が提供するものを確認
- 設定参照:設定ファイルの正確なモデル名を取得
セッション管理
opencode session
会話セッションを管理します。
構文
opencode session [command]
ユースケース
- セッション履歴:過去の会話を確認
- コンテキスト切り替え:異なるプロジェクト間を移動
- セッションクリーンアップ:古いセッションをアーカイブまたは削除
GitHub 統合
opencode github
AI 駆動の GitHub ワークフロー自動化を可能にする OpenCode の GitHub エージェントを管理します。
構文
opencode github [command]
サブコマンド
opencode github install
リポジトリまたは組織の GitHub エージェントをインストールして設定します。
例
# GitHub エージェントをインストール
opencode github install
ユースケース
- リポジトリ自動化:GitHub ワークフロー用の AI アシスタンスをセットアップ
- チームオンボーディング:チームの AI コードレビューを有効化
- CI/CD 統合:OpenCode を GitHub Actions に統合
opencode github run
GitHub エージェントを実行してイベントと自動化タスクを処理します。
例
# GitHub エージェントを実行
opencode github run
ユースケース
- 自動レビュー:AI アシスタンスでプルリクエストを処理
- Issue トリアージ:Issue を自動的に分析して分類
- 継続的アシスタンス:進行中のタスクのためにエージェントを実行し続ける
opencode pr
GitHub プルリクエストのブランチを取得してチェックアウトし、そのコンテキストで OpenCode を起動します。これによりコードレビューワークフローが効率化されます。
構文
opencode pr <number> [options]
例
# PR #42 をチェックアウトして OpenCode を起動
opencode pr 42
# 特定のモデルで PR をレビュー
opencode pr 123 --model anthropic/claude-3.5-sonnet
ユースケース
- コードレビュー:レビューのために PR コンテキストにすばやく移動
- PR アシスタンス:変更を理解するための AI ヘルプを取得
- コラボレーション:コメントする前に AI と PR の変更について議論
プロジェクト初期化
opencode init
AGENTS.md ファイルを作成または更新してプロジェクトを初期化し、OpenCode がプロジェクト構造を理解できるようにします。
構文
opencode init
例
# 現在のプロジェクトを初期化
opencode init
# TUI 内から実行
/init
ユースケース
- 新規プロジェクト:新しいコードベースに OpenCode をセットアップ
- プロジェクト更新:構造変更時に AGENTS.md を更新
- コンテキスト最適化:AI がプロジェクトをより良く理解できるよう支援
データ操作
opencode export
会話データをエクスポートします。
構文
opencode export [options]
ユースケース
- ドキュメント化:参照用に会話を保存
- バックアップ:重要なやり取りをアーカイブ
- 共有:会話をエクスポートして同僚と共有
opencode import
OpenCode にデータをインポートします。
構文
opencode import [options]
ユースケース
- 移行:OpenCode インスタンス間でデータを移動
- 復元:バックアップから復元
- チーム同期:共有会話履歴をインポート
opencode stats
使用統計を表示します。
構文
opencode stats
ユースケース
- コスト追跡:API 使用量とコストを監視
- 使用分析:インタラクションパターンを理解
- 予算管理:支出制限内に収める
グローバルフラグ
これらのフラグは、ほとんどの OpenCode コマンドと共に使用して動作を変更できます。
| フラグ | 短縮形 | 説明 |
|---|---|---|
--continue | -c | 最後のセッションから続行 |
--session | -s | 続行するセッション ID を指定 |
--prompt | - | 使用するプロンプトを定義 |
--model | -m | モデルを指定(形式:provider/model) |
--agent | - | 使用するエージェントを指定 |
--port | - | リッスンするポートを定義 |
--hostname | - | リッスンするホスト名を定義 |
例
# 最後のセッションから続行
opencode --continue
# 特定のモデルを使用
opencode run "Explain this code" --model anthropic/claude-3.5-sonnet
# カスタムポートで起動
opencode web --port 8080