OpenCode CLI の使用

OpenCode は強力なコマンドラインインターフェース(CLI)を提供しており、対話式の TUI を起動できるだけでなく、コマンドによる自動化・スクリプト化操作も実現できます。

デフォルトでは、OpenCode CLI は TUI を起動しますが、その真価はプログラム可能な呼び出しにあります。

OpenCode CLI は単なるコマンドツールではなく、プログラム可能な AI 開発インターフェースです。

OpenCode CLI は3つの層に抽象化できます:

  • 対話層:tui / web / attach
  • 実行層:run / agent / mcp / github
  • サービス層:serve / acp

👉 本質はAI エージェント + ローカル開発環境 + プログラム可能な CLI + Server APIの統合エントリーポイントです。

以下は OpenCode CLI コマンドの完全な表です:

基本動作

コマンド/使い方 機能説明 備考
opencode デフォルトで TUI を起動 パラメータなしの場合
opencode run "msg" 非対話でタスクを実行 自動化/スクリプト

tui 起動パラメータ

フラグ 短縮形 機能説明
--continue -c 前回のセッションを続行
--session -s セッション ID を指定
--fork — セッションをフォーク
--prompt — 初期プロンプト
--model -m モデルを指定
--agent — エージェントを指定
--port — リッスンポート
--hostname — ホストアドレス

コア CLI コマンド

コマンド 機能説明 主要なサブコマンド
agent エージェントを管理 create / list
auth 認証を管理 login / list / logout
attach リモートバックエンドに接続 —
github GitHub 自動化 install / run
mcp MCP サービス管理 add / list / auth / debug
models モデルリストを表示 —
run 非対話で実行 —
serve API サービスを起動 —
web Web UI サービス —
session セッション管理 list
stats トークン/費用統計 —
export セッションをエクスポート —
import セッションをインポート —
acp ACP プロトコルサービスを起動 —
uninstall アンインストール —
upgrade バージョンアップグレード —

run コマンドのパラメータ

フラグ 短縮形 機能説明
--continue -c セッションを続行
--session -s セッションを指定
--fork — フォーク
--share — セッションを共有
--model -m モデルを指定
--agent — エージェントを指定
--file -f ファイルを添付
--format — 出力形式(json)
--title — セッションタイトル
--attach — 既存のサービスに接続
--port — ローカルポート

サービス系コマンドのパラメータ

serve / web / acp

フラグ 機能説明
--port リッスンポート
--hostname ホストアドレス
--mdns LAN ディスカバリー
--cors クロスオリジンを許可

session / stats パラメータ
コマンド フラグ 説明
session --max-count (-n) 直近 N 件
session --format table/json
stats --days 直近 N 日
stats --tools ツール統計
stats --models モデル使用量
stats --project プロジェクト絞り込み

グローバルフラグ

フラグ 短縮形 機能説明
--help -h ヘルプ
--version -v バージョン
--print-logs — ログを出力
--log-level — ログレベル

環境変数

変数 型 機能
OPENCODE_AUTO_SHARE boolean 自動共有
OPENCODE_CONFIG string 設定パス
OPENCODE_TUI_CONFIG string TUI 設定
OPENCODE_DISABLE_AUTOUPDATE boolean アップデートを無効化
OPENCODE_SERVER_PASSWORD string API 認証
OPENCODE_MODELS_URL string モデルソース

実験的機能

変数 型 機能
OPENCODE_EXPERIMENTAL boolean すべての実験的機能を有効化
OPENCODE_EXPERIMENTAL_LSP_TOOL boolean LSP ツール
OPENCODE_EXPERIMENTAL_PLAN_MODE boolean プランニングモード
OPENCODE_EXPERIMENTAL_FILEWATCHER boolean ファイル監視

一、基本的な使い方

1、TUI を起動(デフォルトの動作)

opencode

対話式ターミナルインターフェースに入るのと同じです

2、プロジェクトディレクトリを指定

opencode /path/to/project

指定したディレクトリで TUI を起動します。例えば opencode-サンプル-test ディレクトリで起動する場合:

opencode opencode-サンプル-test

3、非対話モード(スクリプト呼び出し)

opencode run 解释一下 JavaScript 中闭包的原理

結果を直接返し、インターフェースに入りません。


二、CLI のコア機能

OpenCode CLI のコア機能は3つのカテゴリにまとめられます:

  • 対話モード:TUI(デフォルト)
  • コマンド実行:run / serve
  • システム管理:agent / auth / session など

三、よく使うパラメータ(フラグ)

パラメータ 短縮形 説明
--continue -c 前回のセッションを続行
--session -s セッション ID を指定
--fork 現在のセッションからフォーク
--model -m モデルを指定(provider/model)
--agent エージェントを指定
--port サービスポート
--hostname リッスンアドレス

四、コアコマンドの詳細

1、run(最もよく使う)

非対話実行に使用:

opencode run 分析这个 Go 项目的上下文使用方式

適用シーン:

  • スクリプト自動化
  • CI/CD
  • クイックQ&A

バックグラウンドサービスに接続(コールドスタートを回避)

# 启动后台服务
opencode serve

# 使用 run 连接
opencode run --attach http://localhost:4096 解释 async/await

よく使うパラメータ

パラメータ 説明
--model モデルを指定
--file ファイルを添付
--format 出力形式(json / デフォルト)
--share セッションを共有

五、auth(認証管理)

ログイン

opencode auth login

API キーを設定(ローカルに保存)


ログイン済みプロバイダーを表示

opencode auth list

ログアウト

opencode auth logout

六、models(モデル管理)

すべてのモデルを表示

opencode models

プロバイダーで絞り込み

opencode models anthropic

モデルリストを更新

opencode models --refresh

七、agent(エージェントシステム)

エージェントを作成

opencode agent create

プロンプトとツールをカスタマイズ可能

エージェントを表示

opencode agent list

八、session(セッション管理)

セッションを表示

opencode session list

件数を制限

opencode session list -n 10

九、serve(サービスモード)

APIサービスを起動:

opencode serve

HTTPインターフェースを提供(UIなし)

オプションパラメータ:

  • --port:ポート
  • --hostname:リッスンアドレス

十、web(Web UI)

opencode web

Webインターフェース付きのバージョンを起動


十一、mcp(拡張機能)

MCP サービスを追加

opencode mcp add

リストを表示

opencode mcp list

MCPはAIの能力を拡張するために使用します(例:ツール呼び出し)


十二、stats(使用統計)

opencode stats

Token使用量と費用を確認


十三、export / import

セッションをエクスポート

opencode export

セッションをインポート

opencode import session.json

十四、アップグレードとアンインストール

アップグレード

opencode upgrade

アンインストール

opencode uninstall

十五、グローバルパラメータ

パラメータ 説明
--help ヘルプを表示
--version バージョンを表示
--log-level ログレベル

十六、環境変数(高度な設定)

OpenCodeは環境変数による動作の制御をサポートしています。例:

OPENCODE_DISABLE_AUTOUPDATE=true
OPENCODE_SERVER_PASSWORD=123456

一般的な用途:

  • 自動更新を無効化
  • サービス認証の設定
  • 設定パスのカスタマイズ

十七、使用上のアドバイス(重要)

  • 日常開発ではTUIを使用
  • 自動化ではrunを使用
  • 複雑なタスクではagentと組み合わせる
  • 高頻度の呼び出しにはserve + attach
その他の拡張