crllm

Crllm

毫不費力地從大語言模型中獲得代碼評論！

CRLLM是一種強大的命令行工具，使開發人員能夠從最新的大語言模型（LLMS）獲得代碼評論。無論您想將Ollama用於本地運行的LLM，還是連接到諸如Chatgpt，Hugging Face和Azure之類的雲服務，Crllm都可以覆蓋您。提高您的代碼質量，捕獲潛在的錯誤，並收到AI驅動的建議，以增強您的開發工作流程。獲取有關最佳實踐，容易出現蟲子區域和潛在重構的建議。從建議中學習如何改進您的代碼，獲得新的見解和技術。在人類法規審查期間，通過提前捕獲更多問題來減少對來源的需求。

特徵

• 靈活的LLM選項：使用Ollama在本地運行模型或利用OpenAI，擁抱面和Azure等雲提供商的API。
• 全面的代碼審查：獲得有關代碼的質量反饋，包括有關可讀性，效率和最佳實踐的建議。
• 開發人員生產率：無縫集成到您現有的開發環境中，以加快代碼審核流程。
• 隱私控制：根據您的隱私需求和計算能力，在本地或基於雲的解決方案之間進行選擇。
• 多語言支持：以各種編程語言（例如Python，JavaScript，Java等）編寫的評論代碼。
• GIT支持：獲取有關您的GIT更改或分支之間差異的評論。

安裝

要開始使用CRLLM，請按照以下簡單的安裝步驟：

先決條件

• Python 3.8+ ：確保已安裝Python。
• PIPX ：https：//pipx.pypa.io/stable/installation/
• Ollama ：https：//ollama.com/download如果您想在本地運行模型，否則您將需要提供者的相應API鍵

從Github安裝

pipx install git+https://github.com/lukasrump/crllm.git

從PYPI安裝

pipx install crllm

配置

CRLLM支持LLM代碼評論的多個後端。您可以通過在項目根部添加配置文件crllm_config.toml來配置它。要初始化您的項目，您可以使用

crllm -i .

此命令指導您通過最重要的設置。您可以在Wiki中找到有關設置選項的更多信息。

用法

CRLLM的設計易於從您的終端中使用。以下是如何利用該工具的一些示例。

為文件或git存儲庫進行執行代碼審核：

crllm path/to/your/codefile.py

啟用破布支撐

為了通過源上下文增強代碼評論，請在crllm_config.toml中啟用抹布（檢索效果的生成）：

[ rag ]
enabled = true
embedding_model = " all-minilm "      # Specify the embedding model
src_path = " ./ "                     # Define the root path of your source code
src_glob = " **/*.py "                # Use glob patterns to match source files (e.g., Python files)

忽略文件

CRLLM支持一個.crllm_ignore文件，以從代碼評論中排除特定文件和目錄。這類似於.gitignore ，但特定於CRLLM的代碼審核過程。