リファレンス
clinvk のコマンド、設定、API に関する完全な技術リファレンスです。
概要
このリファレンスでは、clinvk の機能、オプション、挙動を詳細に説明します。特定のコマンド構文、設定項目、API エンドポイントについて正確な情報が必要なときに参照してください。
このリファレンスの使い方
- CLI コマンド: 構文、フラグ、例を確認する
- 設定: 利用できる設定項目とデフォルト値を調べる
- 環境変数: 環境変数による設定方法を確認する
- 終了コード: スクリプト化のために終了コードを理解する
- API リファレンス: clinvk をアプリケーションへ組み込む
クイックナビゲーション
| セクション |
説明 |
こんなときに |
| CLI コマンド |
コマンドラインインターフェースの参照 |
コマンド構文やフラグが必要 |
| 設定 |
設定ファイルの項目 |
設定の作成/変更をしたい |
| 環境変数 |
環境変数による設定 |
環境変数で設定したい |
| 終了コード |
プログラムの終了コード |
clinvk を使ったスクリプトを書く |
| API リファレンス |
HTTP API ドキュメント |
アプリへ統合する |
CLI コマンド一覧
設定の優先順位
設定値は次の順序で解決されます(上ほど優先度が高い)。
- CLI フラグ - コマンドライン引数が最優先
- 環境変数 -
CLINVK_* 変数
- 設定ファイル -
~/.clinvk/config.yaml
- デフォルト値 - 組み込みの既定値
# 例: CLI フラグが環境変数より優先される
export CLINVK_BACKEND=codex
clinvk -b claude "prompt" # codex ではなく claude を使用
共通フラグ
これらのフラグは多くのコマンドで共通して利用できます。
| フラグ |
短縮 |
説明 |
例 |
--backend |
-b |
使用するバックエンド |
-b codex |
--model |
-m |
モデルの上書き |
-m o3-mini |
--workdir |
-w |
作業ディレクトリ |
-w ./project |
--output-format |
-o |
出力形式 |
-o json |
--config |
|
設定ファイルのパス |
--config /path/to/config.yaml |
--dry-run |
|
実行せずコマンドのみ表示 |
--dry-run |
--help |
-h |
ヘルプを表示 |
-h |
バックエンド(概要)
| バックエンド |
バイナリ |
既定モデル |
得意分野 |
| Claude |
claude |
バックエンド既定 |
複雑な推論、コードレビュー |
| Codex |
codex |
バックエンド既定 |
手早いコーディング |
| Gemini |
gemini |
バックエンド既定 |
一般的な支援 |
出力形式
| 形式 |
説明 |
得意な用途 |
text |
プレーンテキスト |
人が読む |
json |
構造化 JSON |
スクリプト/パース |
stream-json |
JSON イベントのストリーミング |
リアルタイム処理 |
API 互換性
clinvk は統合のために 3 種類の API スタイルを提供します。
| API スタイル |
エンドポイント接頭辞 |
得意な用途 |
| ネイティブ REST |
/api/v1/ |
clinvk の全機能 |
| OpenAI 互換 |
/openai/v1/ |
OpenAI SDK 利用者 |
| Anthropic 互換 |
/anthropic/v1/ |
Anthropic SDK 利用者 |
困ったときは
- すばやい参照には、どのコマンドでも
--help を使用してください
- よくある問題は トラブルシューティング を確認してください
- よくある質問は FAQ を参照してください