CLI
OpenCtrlC CLI のオプションとコマンド。
OpenCtrlC CLI は、引数なしで実行すると、デフォルトで TUI を開始します。
openctrlcただし、このページに記載されているようにコマンドも受け入れます。これにより、OpenCtrlC をプログラム的に操作できるようになります。
openctrlc run "Explain how closures work in JavaScript"tui
OpenCtrlC ターミナルユーザーインターフェイスを開始します。
openctrlc [project]フラグ
| フラグ | ショート | 説明 |
|---|---|---|
--continue | -c | 最後のセッションを続行 |
--session | 続行時にセッションをフォーク (-s または --fork と併用) | |
--continue | --session | 続行するセッション ID |
--prompt | 使用のプロンプト | |
--model | -m | プロバイダー/モデルの形式で使用するモデル |
--agent | 使用するエージェント | |
--port | リッスンするポート | |
--hostname | リッスンするホスト名 |
コマンド
OpenCtrlC CLI には次のコマンドもあります。
agent
OpenCtrlC のエージェントを管理します。
openctrlc agent [command]attach
serve または web コマンドを使用して起動された、すでに実行中の OpenCtrlC バックエンドサーバーにターミナルを接続します。
openctrlc attach [url]これにより、リモート OpenCtrlC バックエンドで TUI を使用できるようになります。例えば:
# Start the backend server for web/mobile accessopenctrlc web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendopenctrlc attach http://10.20.30.40:4096フラグ
| フラグ | ショート | 説明 |
|---|---|---|
--dir | TUI を開始する作業ディレクトリ | |
--continue | -c | 最後のセッションを続行 |
--session | -s | 続行するセッション ID |
--fork | 続行時にセッションをフォーク(--continue または --session と使用) | |
--password | -p | Basic 認証パスワード(デフォルトは OPENCTRLC_SERVER_PASSWORD) |
--username | -u | Basic 認証ユーザー名(デフォルトは OPENCTRLC_SERVER_USERNAME または openctrlc) |
create
カスタム構成で新しいエージェントを作成します。
openctrlc agent createこのコマンドは、カスタムシステムプロンプトとツール構成を使用して新しいエージェントを作成する手順を示します。
list
利用可能なエージェントをすべてリストします。
openctrlc agent listauth
プロバイダーの資格情報とログインを管理するコマンド。
openctrlc auth [command]login
OpenCtrlC は Models.dev のプロバイダーリストを利用しているため、openctrlc auth login を使用して、使用したいプロバイダーの API キーを構成できます。これは ~/.local/share/openctrlc/auth.json に保存されます。
openctrlc auth loginOpenCtrlC が起動すると、認証情報ファイルからプロバイダーがロードされます。また、環境またはプロジェクト内の .env ファイルで定義されたキーがあるかどうかも確認します。
list
認証情報ファイルに保存されているすべての認証されたプロバイダーをリストします。
openctrlc auth listまたはショートバージョン。
openctrlc auth lslogout
資格情報ファイルからプロバイダーをクリアすることで、プロバイダーからログアウトします。
openctrlc auth logoutgithub
リポジトリ自動化のための GitHub エージェントを管理します。
openctrlc github [command]install
GitHub エージェントをリポジトリにインストールします。
openctrlc github installこれにより、必要な GitHub Actions ワークフローが設定され、構成プロセスがガイドされます。 詳細はこちら。
run
GitHub エージェントを実行します。これは通常、GitHub Actions で使用されます。
openctrlc github runフラグ
| フラグ | 説明 |
|---|---|
--event | エージェントを実行するための GitHub モック イベント |
--token | GitHub 個人アクセストークン |
mcp
モデルコンテキストプロトコルサーバーを管理します。
openctrlc mcp [command]add
MCP サーバーを構成に追加します。
openctrlc mcp addこのコマンドは、ローカルまたはリモートの MCP サーバーを追加する手順を示します。
list
構成されているすべての MCP サーバーとその接続ステータスをリストします。
openctrlc mcp listまたは、短いバージョンを使用してください。
openctrlc mcp lsauth
OAuth 対応の MCP サーバーで認証します。
openctrlc mcp auth [name]サーバー名を指定しない場合は、利用可能な OAuth 対応サーバーから選択するように求められます。
OAuth 対応サーバーとその認証ステータスを一覧表示することもできます。
openctrlc mcp auth listまたは、短いバージョンを使用してください。
openctrlc mcp auth lslogout
MCP サーバーの OAuth 資格情報を削除します。
openctrlc mcp logout [name]debug
MCP サーバーの OAuth 接続の問題をデバッグします。
openctrlc mcp debug <name>models
構成されたプロバイダーから利用可能なすべてのモデルをリストします。
openctrlc models [provider]このコマンドは、構成されたプロバイダー全体で利用可能なすべてのモデルを provider/model の形式で表示します。
これは、設定 で使用する正確なモデル名を把握するのに役立ちます。
オプションでプロバイダー ID を渡して、そのプロバイダーによってモデルをフィルターできます。
openctrlc models anthropicフラグ
| フラグ | 説明 |
|---|---|
--refresh | models.dev からモデルキャッシュを更新します。 |
--verbose | より詳細なモデル出力を使用します (コストなどのメタデータを含む) |
--refresh フラグを使用して、キャッシュされたモデルリストを更新します。これは、新しいモデルがプロバイダーに追加され、それを OpenCtrlC で確認したい場合に便利です。
openctrlc models --refreshrun
プロンプトを直接渡して、非対話モードで openctrlc を実行します。
openctrlc run [message..]これは、スクリプト作成、自動化、または完全な TUI を起動せずに迅速な回答が必要な場合に便利です。例えば。
openctrlc run Explain the use of context in Go実行中の openctrlc serve インスタンスにアタッチして、実行ごとの MCP サーバーのコールドブート時間を回避することもできます。
# Start a headless server in one terminalopenctrlc serve
# In another terminal, run commands that attach to itopenctrlc 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 | -p | Basic 認証パスワード(デフォルトは OPENCTRLC_SERVER_PASSWORD) |
--username | -u | Basic 認証ユーザー名(デフォルトは OPENCTRLC_SERVER_USERNAME または openctrlc) |
--dir | 実行ディレクトリ、またはアタッチ時のリモートサーバー上のパス | |
--variant | モデルバリアント(プロバイダー固有の推論レベル) | |
--thinking | 思考ブロックを表示 | |
--port | ローカルサーバーのポート (デフォルトはランダムポート) |
serve
API アクセスのためにヘッドレス OpenCtrlC サーバーを起動します。完全な HTTP インターフェイスについては、サーバーのドキュメント を確認してください。
openctrlc serveこれにより、TUI インターフェイスを使用せずに openctrlc 機能への API アクセスを提供する HTTP サーバーが起動します。 OPENCTRLC_SERVER_PASSWORD を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは openctrlc)。
フラグ
| フラグ | 説明 |
|---|---|
--port | リッスンするポート |
--hostname | リッスンするホスト名 |
--mdns | mDNS 検出を有効にする |
--cors | CORS を許可する追加のブラウザーオリジン |
session
OpenCtrlC セッションを管理します。
openctrlc session [command]list
すべての OpenCtrlC セッションをリストします。
openctrlc session listフラグ
| フラグ | ショート | 説明 |
|---|---|---|
--max-count | -n | 最新のセッションを N 個に制限 |
--format | 出力形式: テーブルまたは json (テーブル) |
stats
OpenCtrlC セッションのトークンの使用状況とコストの統計を表示します。
openctrlc statsフラグ
| フラグ | 説明 |
|---|---|
--days | 過去 N 日間の統計を表示 (全期間) |
--tools | 表示するツールの数 (すべて) |
--models | モデルの使用状況の内訳を表示 (デフォルトでは非表示)。上位 N 件を表示するには数値を渡します |
--project | プロジェクトでフィルタリング (全プロジェクト、空文字列: 現在のプロジェクト) |
export
セッションデータを JSON としてエクスポートします。
openctrlc export [sessionID]セッション ID を指定しない場合は、利用可能なセッションから選択するように求められます。
import
JSON ファイルまたは OpenCtrlC 共有 URL からセッションデータをインポートします。
openctrlc import <file>ローカルファイルまたは OpenCtrlC 共有 URL からインポートできます。
openctrlc import session.jsonopenctrlc import https://your-sharing-service.example/s/abc123web
Web インターフェイスを使用してヘッドレス OpenCtrlC サーバーを起動します。
openctrlc webこれにより、HTTP サーバーが起動し、Web ブラウザが開き、Web インターフェイスを通じて OpenCtrlC にアクセスします。 OPENCTRLC_SERVER_PASSWORD を設定して HTTP 基本認証を有効にします (ユーザー名のデフォルトは openctrlc)。
フラグ
| フラグ | 説明 |
|---|---|
--port | リッスンするポート |
--hostname | リッスンするホスト名 |
--mdns | mDNS 検出を有効にする |
--cors | CORS を許可する追加のブラウザーオリジン |
acp
ACP (エージェントクライアントプロトコル) サーバーを起動します。
openctrlc acpこのコマンドは、nd-JSON を使用して stdin/stdout 経由で通信する ACP サーバーを起動します。
フラグ
| フラグ | 説明 |
|---|---|
--cwd | 作業ディレクトリ |
--port | リッスンするポート |
--hostname | リッスンするホスト名 |
uninstall
OpenCtrlC をアンインストールし、関連ファイルをすべて削除します。
openctrlc uninstallフラグ
| フラグ | ショート | 説明 |
|---|---|---|
--keep-config | -c | 構成ファイルを保持する |
--keep-data | -d | セッションデータとスナップショットを保持する |
--dry-run | 削除せずに削除される内容を表示する | |
--force | -f | 確認プロンプトをスキップする |
upgrade
openctrlc を最新バージョンまたは特定のバージョンに更新します。
openctrlc upgrade [target]最新バージョンにアップグレードするには。
openctrlc upgrade特定のバージョンにアップグレードするには。
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 | ブール値 | ワークスペースサポートを有効にする |