UStackUStack
OpenBug CLI icon

OpenBug CLI

OpenBug CLIはAIアシストのCLIで、実行中のログを取り込みつつローカルコードを検索し、対話型ターミナルでデバッグ質問に回答します。

OpenBug CLI

OpenBug CLIとは?

OpenBug CLIは、AIアシストによる実行中アプリケーションのデバッグ用インテリジェントCLIツールです。対話型ターミナルアシスタントをローカルクラスタと組み合わせ、サービス実行中にログをキャプチャし、それらのログとコードベースを使ってデバッグ質問に回答します。

主な目的は、ランタイム動作(ログ)とソースコード間のコンテキストスイッチを減らすことです。複数のターミナルやファイルを手動でgrepする代わりに、何が起きているかを質問し、CLIが関連ログをローカルでアクセス可能なコードと相関づけます。

主な機能

  • 対話型ターミナルAIアシスタント (debug): 1つのターミナルでアシスタントを起動し、サービス実行中に問題について質問。
  • 自動ログキャプチャとストリーミング: debug <command> でサービスを実行すると、OpenBugがログをローカルクラスタにストリーミングし、AI応答に使用。
  • ローカルコードベース全体の自然言語コード検索: アシスタントが「この動作はどこで実装されているか」などの質問に応じてコードベースを検索。
  • 共有ローカルクラスタによる複数サービスデバッグ: 別々のターミナルで異なるサービスを実行;すべて同じクラスタに接続し、AIがスタック全体の問題を追跡。
  • ローカル優先アクセスと選択的データ共有: コードベースはローカルでアクセスしアップロードせず;AIがクエリした特定スニペットのみサーバーに送信、ログは回答が必要時のみストリーミング。
  • 個人APIキーによる認証リクエスト: CLIがセットアップフローで説明されるAPIキーでリクエストを認証。

OpenBug CLIの使い方

  1. CLIをインストール:
    npm install -g @openbug/cli
    
  2. ターミナル1でAIアシスタントを起動:
    debug
    
    OpenBugアプリからAPIキーを貼り付けてログインを促されます。
  3. 他のターミナルでデバッグ有効でサービスを実行。リポジトリの例:
    debug npm run dev
    debug python app.py
    debug docker-compose up
    
  4. サービス実行中にターミナル1でデバッグ質問。アシスタントがキャプチャログを解析し、コードベースを検索して的確な洞察を提供。

セットアップなしでテストする場合、プロジェクトが3つの現実的なバグをデバッグするインタラクティブデモを提供。

ユースケース

  • ローカル開発中のエンドポイント障害診断: バックエンド実行中に「認証が失敗する理由は?」などと質問;アシスタントが関連ログを参照し、検証ロジックを特定。
  • 複数サービス間の問題追跡: debug ... でバックエンドとフロントエンド(または複数バックエンド)を別ターミナルで実行;AIが複数サービスのログを使ってエラー伝播を説明。
  • 未知動作の実装箇所特定: 「支払いWebhookはどこで処理?」のような自然言語質問で、アシスタントがローカルリポジトリを検索。
  • ランタイムで観察されるデータ不整合調査: ログがスキーマ不整合や設定エラーを示唆したら、AIにログ行と関連コードパスを相関づけ。
  • インターネット検索なしで未知コードベースをデバッグ: アシスタントが実際のローカルコードベースを検索し、一般的なガイダンスではなく。

FAQ

  • OpenBugはコードベース全体をアップロードしますか? いいえ。ドキュメントによると、コードベースはローカルでアクセスされアップロードされず;AIがクエリした特定コードスニペットのみサーバーに送信。

  • OpenBugはいつログをサーバーに送信しますか? AIが質問に回答する必要がある時のみ、ログをサーバーにストリーミング。

  • OpenBugは複数サービス間のデバッグをどうサポート? 共有ローカルクラスタを使用:debug <command> で別ターミナルで複数サービスを実行し、すべて同じクラスタに接続してAIがスタック全体のログを相関。

  • OpenBugサーバーをセルフホストできますか? はい。リポジトリがセルフホスト方法を説明:サーバーリポジトリをクローンし、OpenAI APIキーで設定後、WEB_SOCKET_URLAPI_BASE_URL などの環境変数でCLIをサーバー指向。

代替案

  • ログ + テキスト検索(例: grep/ripgrep) + IDEツールによるローカルデバッグ: 類似の入力(ログとソースコード)ですが、ワークフローは手動の相関とナビゲーションに依存し、AIアシストの会話型インターフェースではありません。
  • アプリケーションのパフォーマンス/可観測性プラットフォーム(ログとトレーシングダッシュボード): ランタイムデータを閲覧・クエリするのに有用ですが、ローカルリポジトリからの自然言語・コード認識デバッグは通常提供しません。
  • リポジトリQ&Aに特化したAIコードアシスタント(ランタイムログキャプチャなし): コード構造に関する質問に答えられますが、実行中サービスのログを自動キャプチャしてランタイム挙動に基づく回答はしません。