コンテンツにスキップ

CLI

OpenCtrlC CLI のオプションとコマンド。

OpenCtrlC CLI は、引数なしで実行すると、デフォルトで TUI を開始します。

Terminal window
openctrlc

ただし、このページに記載されているようにコマンドも受け入れます。これにより、OpenCtrlC をプログラム的に操作できるようになります。

Terminal window
openctrlc run "Explain how closures work in JavaScript"

tui

OpenCtrlC ターミナルユーザーインターフェイスを開始します。

Terminal window
openctrlc [project]

フラグ

フラグショート説明
--continue-c最後のセッションを続行
--session続行時にセッションをフォーク (-s または --fork と併用)
--continue--session続行するセッション ID
--prompt使用のプロンプト
--model-mプロバイダー/モデルの形式で使用するモデル
--agent使用するエージェント
--portリッスンするポート
--hostnameリッスンするホスト名

コマンド

OpenCtrlC CLI には次のコマンドもあります。


agent

OpenCtrlC のエージェントを管理します。

Terminal window
openctrlc agent [command]

attach

serve または web コマンドを使用して起動された、すでに実行中の OpenCtrlC バックエンドサーバーにターミナルを接続します。

Terminal window
openctrlc attach [url]

これにより、リモート OpenCtrlC バックエンドで TUI を使用できるようになります。例えば:

Terminal window
# Start the backend server for web/mobile access
openctrlc web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
openctrlc attach http://10.20.30.40:4096

フラグ

フラグショート説明
--dirTUI を開始する作業ディレクトリ
--continue-c最後のセッションを続行
--session-s続行するセッション ID
--fork続行時にセッションをフォーク(--continue または --session と使用)
--password-pBasic 認証パスワード(デフォルトは OPENCTRLC_SERVER_PASSWORD)
--username-uBasic 認証ユーザー名(デフォルトは OPENCTRLC_SERVER_USERNAME または openctrlc)

create

カスタム構成で新しいエージェントを作成します。

Terminal window
openctrlc agent create

このコマンドは、カスタムシステムプロンプトとツール構成を使用して新しいエージェントを作成する手順を示します。


list

利用可能なエージェントをすべてリストします。

Terminal window
openctrlc agent list

auth

プロバイダーの資格情報とログインを管理するコマンド。

Terminal window
openctrlc auth [command]

login

OpenCtrlC は Models.dev のプロバイダーリストを利用しているため、openctrlc auth login を使用して、使用したいプロバイダーの API キーを構成できます。これは ~/.local/share/openctrlc/auth.json に保存されます。

Terminal window
openctrlc auth login

OpenCtrlC が起動すると、認証情報ファイルからプロバイダーがロードされます。また、環境またはプロジェクト内の .env ファイルで定義されたキーがあるかどうかも確認します。


list

認証情報ファイルに保存されているすべての認証されたプロバイダーをリストします。

Terminal window
openctrlc auth list

またはショートバージョン。

Terminal window
openctrlc auth ls

logout

資格情報ファイルからプロバイダーをクリアすることで、プロバイダーからログアウトします。

Terminal window
openctrlc auth logout

github

リポジトリ自動化のための GitHub エージェントを管理します。

Terminal window
openctrlc github [command]

install

GitHub エージェントをリポジトリにインストールします。

Terminal window
openctrlc github install

これにより、必要な GitHub Actions ワークフローが設定され、構成プロセスがガイドされます。 詳細はこちら。


run

GitHub エージェントを実行します。これは通常、GitHub Actions で使用されます。

Terminal window
openctrlc github run
フラグ
フラグ説明
--eventエージェントを実行するための GitHub モック イベント
--tokenGitHub 個人アクセストークン

mcp

モデルコンテキストプロトコルサーバーを管理します。

Terminal window
openctrlc mcp [command]

add

MCP サーバーを構成に追加します。

Terminal window
openctrlc mcp add

このコマンドは、ローカルまたはリモートの MCP サーバーを追加する手順を示します。


list

構成されているすべての MCP サーバーとその接続ステータスをリストします。

Terminal window
openctrlc mcp list

または、短いバージョンを使用してください。

Terminal window
openctrlc mcp ls

auth

OAuth 対応の MCP サーバーで認証します。

Terminal window
openctrlc mcp auth [name]

サーバー名を指定しない場合は、利用可能な OAuth 対応サーバーから選択するように求められます。

OAuth 対応サーバーとその認証ステータスを一覧表示することもできます。

Terminal window
openctrlc mcp auth list

または、短いバージョンを使用してください。

Terminal window
openctrlc mcp auth ls

logout

MCP サーバーの OAuth 資格情報を削除します。

Terminal window
openctrlc mcp logout [name]

debug

MCP サーバーの OAuth 接続の問題をデバッグします。

Terminal window
openctrlc mcp debug <name>

models

構成されたプロバイダーから利用可能なすべてのモデルをリストします。

Terminal window
openctrlc models [provider]

このコマンドは、構成されたプロバイダー全体で利用可能なすべてのモデルを provider/model の形式で表示します。

これは、設定 で使用する正確なモデル名を把握するのに役立ちます。

オプションでプロバイダー ID を渡して、そのプロバイダーによってモデルをフィルターできます。

Terminal window
openctrlc models anthropic

フラグ

フラグ説明
--refreshmodels.dev からモデルキャッシュを更新します。
--verboseより詳細なモデル出力を使用します (コストなどのメタデータを含む)

--refresh フラグを使用して、キャッシュされたモデルリストを更新します。これは、新しいモデルがプロバイダーに追加され、それを OpenCtrlC で確認したい場合に便利です。

Terminal window
openctrlc models --refresh

run

プロンプトを直接渡して、非対話モードで openctrlc を実行します。

Terminal window
openctrlc run [message..]

これは、スクリプト作成、自動化、または完全な TUI を起動せずに迅速な回答が必要な場合に便利です。例えば。

Terminal window
openctrlc run Explain the use of context in Go

実行中の openctrlc serve インスタンスにアタッチして、実行ごとの MCP サーバーのコールドブート時間を回避することもできます。

Terminal window
# Start a headless server in one terminal
openctrlc serve
# In another terminal, run commands that attach to it
openctrlc 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実行中の openctrlc サーバー (http://localhost:4096 など) に接続します。
--password-pBasic 認証パスワード(デフォルトは OPENCTRLC_SERVER_PASSWORD)
--username-uBasic 認証ユーザー名(デフォルトは OPENCTRLC_SERVER_USERNAME または openctrlc)
--dir実行ディレクトリ、またはアタッチ時のリモートサーバー上のパス
--variantモデルバリアント(プロバイダー固有の推論レベル)
--thinking思考ブロックを表示
--portローカルサーバーのポート (デフォルトはランダムポート)

serve

API アクセスのためにヘッドレス OpenCtrlC サーバーを起動します。完全な HTTP インターフェイスについては、サーバーのドキュメント を確認してください。

Terminal window
openctrlc serve

これにより、TUI インターフェイスを使用せずに openctrlc 機能への API アクセスを提供する HTTP サーバーが起動します。 OPENCTRLC_SERVER_PASSWORD を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは openctrlc)。

フラグ

フラグ説明
--portリッスンするポート
--hostnameリッスンするホスト名
--mdnsmDNS 検出を有効にする
--corsCORS を許可する追加のブラウザーオリジン

session

OpenCtrlC セッションを管理します。

Terminal window
openctrlc session [command]

list

すべての OpenCtrlC セッションをリストします。

Terminal window
openctrlc session list
フラグ
フラグショート説明
--max-count-n最新のセッションを N 個に制限
--format出力形式: テーブルまたは json (テーブル)

stats

OpenCtrlC セッションのトークンの使用状況とコストの統計を表示します。

Terminal window
openctrlc stats

フラグ

フラグ説明
--days過去 N 日間の統計を表示 (全期間)
--tools表示するツールの数 (すべて)
--modelsモデルの使用状況の内訳を表示 (デフォルトでは非表示)。上位 N 件を表示するには数値を渡します
--projectプロジェクトでフィルタリング (全プロジェクト、空文字列: 現在のプロジェクト)

export

セッションデータを JSON としてエクスポートします。

Terminal window
openctrlc export [sessionID]

セッション ID を指定しない場合は、利用可能なセッションから選択するように求められます。


import

JSON ファイルまたは OpenCtrlC 共有 URL からセッションデータをインポートします。

Terminal window
openctrlc import <file>

ローカルファイルまたは OpenCtrlC 共有 URL からインポートできます。

Terminal window
openctrlc import session.json
openctrlc import https://your-sharing-service.example/s/abc123

web

Web インターフェイスを使用してヘッドレス OpenCtrlC サーバーを起動します。

Terminal window
openctrlc web

これにより、HTTP サーバーが起動し、Web ブラウザが開き、Web インターフェイスを通じて OpenCtrlC にアクセスします。 OPENCTRLC_SERVER_PASSWORD を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは openctrlc)。

フラグ

フラグ説明
--portリッスンするポート
--hostnameリッスンするホスト名
--mdnsmDNS 検出を有効にする
--corsCORS を許可する追加のブラウザーオリジン

acp

ACP (エージェントクライアントプロトコル) サーバーを起動します。

Terminal window
openctrlc acp

このコマンドは、nd-JSON を使用して stdin/stdout 経由で通信する ACP サーバーを起動します。

フラグ

フラグ説明
--cwd作業ディレクトリ
--portリッスンするポート
--hostnameリッスンするホスト名

uninstall

OpenCtrlC をアンインストールし、関連ファイルをすべて削除します。

Terminal window
openctrlc uninstall

フラグ

フラグショート説明
--keep-config-c構成ファイルを保持する
--keep-data-dセッションデータとスナップショットを保持する
--dry-run削除せずに削除される内容を表示する
--force-f確認プロンプトをスキップする

upgrade

openctrlc を最新バージョンまたは特定のバージョンに更新します。

Terminal window
openctrlc upgrade [target]

最新バージョンにアップグレードするには。

Terminal window
openctrlc upgrade

特定のバージョンにアップグレードするには。

Terminal window
openctrlc upgrade v0.1.48

フラグ

フラグショート説明
--method-m使用されたインストール方法。curl, npm, pnpm, bun, brew

グローバルフラグ

openctrlc CLI は次のグローバルフラグを受け取ります。

フラグショート説明
--help-hヘルプを表示
--version-vバージョン番号を出力
--print-logsログを標準エラー出力に出力
--log-levelログレベル (DEBUG、INFO、WARN、ERROR)

環境変数

OpenCtrlC は環境変数を使用して構成できます。

変数タイプ説明
OPENCTRLC_AUTO_SHAREブール値セッションを自動的に共有する
OPENCTRLC_GIT_BASH_PATH文字列Windows 上で実行可能な Git Bash へのパス
OPENCTRLC_CONFIG文字列構成ファイルへのパス
OPENCTRLC_CONFIG_DIR文字列config ディレクトリへのパス
OPENCTRLC_CONFIG_CONTENT文字列インライン JSON 構成コンテンツ
OPENCTRLC_DISABLE_AUTOUPDATEブール値自動更新チェックを無効にする
OPENCTRLC_DISABLE_PRUNEブール値古いデータのプルーニングを無効にする
OPENCTRLC_DISABLE_TERMINAL_TITLEブール値ターミナルタイトルの自動更新を無効にする
OPENCTRLC_PERMISSION文字列インライン化された json 権限設定
OPENCTRLC_DISABLE_DEFAULT_PLUGINSブール値デフォルトのプラグインを無効にする
OPENCTRLC_DISABLE_LSP_DOWNLOADブール値LSP サーバーの自動ダウンロードを無効にする
OPENCTRLC_ENABLE_EXPERIMENTAL_MODELSブール値実験モデルを有効にする
OPENCTRLC_DISABLE_AUTOCOMPACTブール値自動コンテキスト圧縮を無効にする
OPENCTRLC_DISABLE_CLAUDE_CODEブール値.claude からの読み取りを無効にする (プロンプト + スキル)
OPENCTRLC_DISABLE_CLAUDE_CODE_PROMPTブール値~/.claude/CLAUDE.md の読み取りを無効にする
OPENCTRLC_DISABLE_CLAUDE_CODE_SKILLSブール値.claude/skills のロードを無効にする
OPENCTRLC_DISABLE_MODELS_FETCHブール値リモートソースからのモデルの取得を無効にする
OPENCTRLC_FAKE_VCS文字列テスト目的の偽の VCS プロバイダー
OPENCTRLC_CLIENT文字列クライアント識別子 (デフォルトは cli)
OPENCTRLC_ENABLE_EXAブール値Exa Web 検索ツールを有効にする
OPENCTRLC_SERVER_PASSWORD文字列serve/web の基本認証を有効にする
OPENCTRLC_SERVER_USERNAME文字列基本認証ユーザー名 (デフォルト openctrlc) をオーバーライドします。
OPENCTRLC_MODELS_URL文字列モデル設定を取得するためのカスタム URL

実験的

これらの環境変数により、変更または削除される可能性のある実験的な機能が有効になります。

変数タイプ説明
OPENCTRLC_EXPERIMENTALブール値アンブレラフラグ配下の実験的機能を有効にする
OPENCTRLC_EXPERIMENTAL_ICON_DISCOVERYブール値アイコン検出を有効にする
OPENCTRLC_EXPERIMENTAL_DISABLE_COPY_ON_SELECTブール値TUI で選択時のコピーを無効にする
OPENCTRLC_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS数値bash コマンドのデフォルトのタイムアウト (ミリ秒)
OPENCTRLC_EXPERIMENTAL_OUTPUT_TOKEN_MAX数値LLM 応答の最大出力トークン
OPENCTRLC_EXPERIMENTAL_FILEWATCHERブール値ディレクトリ全体のファイル監視を有効にする
OPENCTRLC_EXPERIMENTAL_OXFMTブール値oxfmt フォーマッタを有効にする
OPENCTRLC_EXPERIMENTAL_LSP_TOOLブール値実験的な LSP ツールを有効にする
OPENCTRLC_EXPERIMENTAL_DISABLE_FILEWATCHERブール値ファイルウォッチャーを無効にする
OPENCTRLC_EXPERIMENTAL_EXAブール値実験的な Exa 機能を有効にする
OPENCTRLC_EXPERIMENTAL_LSP_TYブール値python ファイルの TY LSP を有効にする
OPENCTRLC_EXPERIMENTAL_PLAN_MODEブール値プランモードを有効にする
OPENCTRLC_EXPERIMENTAL_BACKGROUND_SUBAGENTSブール値バックグラウンド subagent タスクを有効にする
OPENCTRLC_EXPERIMENTAL_EVENT_SYSTEMブール値実験的なイベントシステムを有効にする
OPENCTRLC_EXPERIMENTAL_NATIVE_LLMブール値ネイティブ LLM リクエスト経路を有効にする
OPENCTRLC_EXPERIMENTAL_PARALLELブール値並列 Web 検索実行を有効にする
OPENCTRLC_EXPERIMENTAL_SCOUTブール値Scout subagent を有効にする
OPENCTRLC_EXPERIMENTAL_WORKSPACESブール値ワークスペースサポートを有効にする