CLI リファレンス¶
このページでは、Yomika のデスクトップバイナリが公開しているコマンドラインオプションを説明します。
Yomika は同じバイナリで次の用途を兼ねます。
- デスクトップ起動
- headless ローカル Web UI
- ローカル HTTP API
- 組み込み MCP サーバー
基本的な使い方¶
# macOS / Linux
yomika [OPTIONS]
# Windows
yomika.exe [OPTIONS]
オプション¶
| オプション | 意味 |
|---|---|
-d, --download |
ランタイムライブラリと既定の vision / OCR スタックを事前取得して終了する |
--cpu |
GPU が利用可能でも CPU モードを強制する |
-p, --port <PORT> |
ローカル HTTP サーバーを指定したポートにバインドする |
--host <HOST> |
HTTP サービスを 127.0.0.1 ではなく特定のホストにバインドする |
--headless |
デスクトップ GUI を起動せずに実行する |
--debug |
デバッグ向けのコンソール出力を有効にする |
挙動に関するメモ¶
一部のフラグは、見た目だけでなく実際の挙動も変えます。
--portを指定しない場合、リリースビルドは4000から開始し、次の空きポートへ進みます。デバッグビルドは4000に固定してバインドします--hostを指定しないと、Yomika は127.0.0.1のみにバインドし、API は同じマシンからのみ到達可能になります--headlessを付けると、Tauri ウィンドウは開かれませんが Web UI と API は提供されます--downloadを付けると、依存物の事前取得後に終了し、そのまま待機しません--cpuを付けると、vision スタックとローカル LLM の両方で GPU アクセラレーションを使いません
固定ポートを指定した場合の主なローカルエンドポイントは次の通りです。
http://localhost:<PORT>/http://localhost:<PORT>/api/v1http://localhost:<PORT>/mcp
よくある使い方¶
固定ポートで headless Web UI を起動する:
yomika --port 4000 --headless
CPU のみで起動する:
yomika --cpu
ランタイムパッケージを事前にダウンロードする:
yomika --download
固定ポートでローカル MCP エンドポイントを立ち上げる:
yomika --port 9999
その上で、MCP クライアントを次に接続します。
http://localhost:9999/mcp
明示的にデバッグログ付きで起動する:
yomika --debug
ローカルネットワーク上の他のマシンからも Web UI と API に到達できるよう、すべてのインターフェイスにバインドする:
yomika --host 0.0.0.0 --port 4000 --headless
これは、デスクトップクライアントが別ホストにある状況で、Yomika をコンテナや VM 内で動かす際の典型的なパターンです。127.0.0.1 以外をネットワークから到達可能にするのは意図的な操作なので、--host は本当に非ループバックでのアクセスが必要なときだけ指定してください。