ompweb/README.ja.md

ompweb

English | 简体中文 | 日本語

コミュニティ：OMPWEB Discord に参加

oh-my-pi (omp) コーディングエージェント向けのモダンな Web UI です。ローカルの omp セッションを読み込み、ブラウザから対話、プロジェクト閲覧、設定管理、ファイルプレビューを行えるワークスペースを提供します。

スクリーンショット（ライト / ダークテーマ）

必要条件

• omp がインストールされ、PATH に含まれていること（または OMP_WEB_OMP_BIN で指定）
• Node.js >= 22.19.0

クイックスタート

インストールせずに直接実行:

npx @kahme247/ompweb@latest

またはグローバルにインストール:

npm install -g @kahme247/ompweb
ompweb

ブラウザで http://127.0.0.1:30177 を開きます。

CLI オプション

ompweb --port 8080                         # ポート番号指定
ompweb --hostname 0.0.0.0                  # ネットワーク公開
ompweb --password "your-password"          # パスワード認証を有効化
ompweb --no-open                           # ブラウザ自動起動を無効化

主な機能

• リアルタイムチャット: ローカルの omp エージェントとストリーミング対話。
• キュー削除の確認: キュー内のフォローアップやステアメッセージをパネルから削除する前に、内容を表示して確認します。OMP 内部ですでにキューに入ったメッセージの配信は取り消しません。
• セッション管理: プロジェクトごとに履歴を一覧表示、分岐やフォークにも対応。
• 下書きの復元: 未送信のテキストを会話または新規セッションのワークスペースごとに保存し、ブラウザストレージが利用可能な場合は、同じタブでの「戻る」「進む」や再読み込み後に復元します（最大 50 件）。画像と添付ファイルはメモリ内にのみ保持されます。
• ライブタスク＆サブエージェント: Todo リストと稼働中サブエージェントの進捗を折りたたみパネルでリアルタイム表示。
• ファイル閲覧・プレビュー: チャットと並べてファイルを閲覧、コード・Markdown・画像・音声・PDF をプレビュー。
• Git Worktree サポート: サイドバーから直接 Git ワークツリーを切り替え・管理。
• GUI 設定管理: 設定ファイルを直接編集することなく、モデル、API キー、MCP サーバー、スキル、プラグイン、OMP 設定を変更可能。
• スラッシュコマンド・ショートカット: /plan、/review、/fix、/test などの定型プロンプトと ⌘K / Ctrl+K コマンドパレット。
• テーマと多言語対応: ペーパー調のライト/ダークテーマ、英語・簡体字中国語・日本語に完全対応。

環境変数

変数名	説明	デフォルト値
PORT	サーバーポート	30177
OMP_WEB_HOSTNAME	バインドホスト	127.0.0.1
OMP_WEB_PASSWORD	Web ログイン用パスワード	なし（認証無効）
OMP_WEB_NO_OPEN	1 でブラウザ自動起動を無効化	0
OMP_WEB_OMP_BIN	omp の絶対パス（PATH 未登録時）	自動検出
PI_CODING_AGENT_DIR	カスタム omp エージェントディレクトリ	~/.omp/agent
OMP_WEB_STT_ENDPOINT	OpenAI 互換の音声認識エンドポイント URL	なし（無効）
OMP_WEB_STT_KEY	STT エンドポイント用の API キー	なし
OMP_WEB_STT_MODEL	STT エンドポイント用のモデル名	なし

開発

git clone https://github.com/kahme247/ompweb.git
cd ompweb
npm install
npm run dev

ローカル開発サーバーは http://127.0.0.1:30178 で起動します。

チェックコマンド

npm run typecheck   # 型チェック (TypeScript)
npm run lint        # ESLint
npm test            # テスト実行

注意: ローカル開発中に npm run build を実行しないでください（.next/ が生成され npm run dev に影響を与える恐れがあります）。

クレジットとライセンス

• agegr/pi-web (MIT) をベースに can1357/oh-my-pi 向けに適合・拡張したフォークです。
• MIT ライセンス のもとで公開されています。