OpenBug CLI icon

OpenBug CLI

OpenBug CLI 是一款命令列除錯工具,運用 AI 分析即時應用程式日誌並在執行命令時搜尋本地程式碼,適合需要在終端機進行跨一個或多個服務即時除錯的開發者。

OpenBug CLI

概覽

OpenBug CLI 是一款搭配 AI 輔助,用於除錯執行中應用程式的命令列工具。它結合了終端機助理、即時日誌擷取與本地程式碼庫搜尋,讓你在應用程式實際執行時就能排查問題。

整體工作流程以 `debug` 為核心:一個終端機啟動助理,另一個則透過 `debug <command>` 執行你的應用程式或服務。README 表示,這可用於單一服務或連接到同一本地叢集的多個服務,同時維持程式碼存取在本機,並僅在分析需要時串流傳送日誌。

核心功能

雙終端機除錯流程

在一個終端機中執行 AI 助理,同時由另一個指令啟動你的應用程式進行除錯。這讓除錯對話能與即時程序保持貼近。

自動日誌擷取

自動擷取執行中服務的日誌,並提供給助理使用,讓回覆建立在執行時行為之上,而不只是靜態分析。

自然語言程式碼搜尋

以自然語言搜尋本地程式碼庫,可詢問例如 webhook 或 token 驗證流程是在哪裡處理,而不必手動使用 grep。

多服務協調

將多個執行中的服務連接到同一個本地叢集,讓助理能跨更大的技術堆疊關聯日誌與程式碼。

終端機與瀏覽器介面

提供瀏覽器版 `studio` 模式與終端機 UI,並附有切換檢視、重新連線與管理聊天/日誌顯示的快捷鍵。

專案設定

支援首次專案設定,會建立 `openbug.yaml` 並自動將服務註冊到本地叢集。

適用情境

  • 除錯即時應用程式

    在助理監看日誌並回答應用程式於執行時的行為時,使用 `debug <command>` 執行服務。

  • 排查多服務技術堆疊

    將後端與前端服務連接到同一個叢集,讓助理能透過多個終端機中的日誌追蹤失敗。

  • 快速熟悉程式碼庫

    以自然語言詢問不熟悉的程式碼,例如某項功能或驗證流程是如何實作的,並讓助理在本機搜尋。

  • 切換到視覺化除錯檢視

    當你想要不同於終端機的除錯介面,並需要以視覺方式檢視聊天或日誌時,使用瀏覽器 `studio` 檢視。

  • 標準化專案設定

    透過首次執行提示與產生的 `openbug.yaml` 設定新專案,以便之後再次執行時重用相同設定。

Pros and Cons

Pros

  • 將命令執行、日誌與 AI 指引整合在一個以終端機為中心的工作流程中。
  • 使用執行時日誌與本地程式碼搜尋,讓回覆比單純的靜態程式碼輔助更具上下文感。
  • 支援跨連接到同一叢集的多個服務進行除錯。
  • 同時提供終端機與瀏覽器介面,並附有切換檢視與重新連線的快捷鍵。

Cons

  • 此專案標示為 beta 且仍在積極開發中,因此行為與工作流程可能仍會變動。
  • 它需要特定設定,包括本地叢集、API 金鑰以及 Node.js 20+。
  • README 指出程式碼會在本機存取,且只有選取的片段會被傳送,這對於希望完全離線工作流程的團隊可能是一項限制。

FAQ

我該如何為新專案進行設定?

OpenBug CLI 會在一個終端機中啟動 AI 助理,並在另一個終端機中執行你的應用程式指令。首次在某個目錄中使用時,它會提示你輸入專案描述,並建立 `openbug.yaml` 設定檔。

OpenBug CLI 可以幫助什麼?

README 表示,OpenBug 可以自動擷取日誌、以自然語言搜尋你的程式碼庫,並與理解執行中系統的 AI 對話。它是為除錯即時應用程式而設計,而不是靜態程式碼審查。

它可以跨多個服務運作嗎?

這個 CLI 支援多個服務分別在不同終端機執行,並連接到同一個本地叢集的工作流程,因此 AI 可以跨服務檢查日誌,並搜尋多個儲存庫中的程式碼。

會送出哪些資料到伺服器?

README 說明你的程式碼會保留在本機並在本機存取,而只有 AI 詢問到的特定片段會傳送到伺服器。日誌只會在回答問題需要時才串流傳送。

它適合用在正式生產環境嗎?

OpenBug CLI 目前處於 beta 且仍在積極開發中。原始碼也列出 Node.js 20+ 與相容的套件管理工具為需求,因此使用者應預期這是一個仍在演進、且具有明確執行環境設定的工具。

Quick Facts

類別
開發者工具
主要介面
終端機 CLI,另有可選的瀏覽器 studio
套件名稱
@openbug/cli
指令
`debug`
需求
Node.js 20+,以及 npm、yarn 或 bun
來源網域
github.com