mufeedvh/code2prompt

A CLI tool to convert your codebase into a single LLM prompt with source tree, prompt templating, and token counting.

解決的問題

Code2Prompt 消除了手動從程式碼庫中複製和格式化多個檔案以提供大型語言模型(LLMs)上下文的繁瑣工作。它自動化了收集相關程式碼、遵守專案規則,並將資料結構化為單一 LLM 就緒提示的過程。

工作原理

該工具使用 Rust 建構以實現高效能,遍歷您的專案目錄並根據指定的過濾器讀取檔案。它尊重 .gitignore 規則,並支援自訂 glob 模式來包含或排除特定檔案。收集到的程式碼隨後透過 Handlebars 模板進行處理,根據提示工程層面的具體情況格式化提示內容。同時,它也會追蹤令牌使用情況,確保生成的提示符合 LLM 的上下文視窗限制。

適用對象

  • 開發者:需要手動向 ChatGPT 等 LLM 提供程式碼庫上下文的使用者。
  • AI Agent 開發者:使用 Python SDK 建構自動化腳本或 RAG 流水線的開發者。
  • 智能應用:使用 MCP 伺服器高效讀取本地程式碼庫的代理應用。

主要亮點

  • 互動式 TUI:提供終端使用者介面,便於設定提示。
  • 智能過濾:自動尊重 .gitignore 並支援 glob 模式。
  • 靈活模板:支援自訂 Handlebars 模板,實現客製化提示結構。
  • Git 集成:可包含 Git diff、日誌和分支對比。
  • 令牌追蹤:即時監控令牌數量,避免上下文溢出。
  • 高效能:核心邏輯使用 Rust 實作,確保快速且低資源消耗。

相關

  • 專案
  • 專案
  • 專案
  • 專案