AICodeBot

人工智慧程式碼機器人？

您的人工智慧編碼助手

AICodeBot 是一款基於終端的編碼助手，旨在讓您的編碼生活更輕鬆。將其視為結對程式設計師的人工智慧版本。執行程式碼審查、建立有用的提交訊息、調試問題並幫助您思考建立新功能。加快開發速度並幫助您編寫更好程式碼的團隊成員。

我們計劃建立多個不同的介面來與 AICodeBot 互動。首先，它是一個可以在終端機中安裝和運行的命令列工具，以及一個用於程式碼審查的 GitHub 操作。

狀態：這個專案是在人工智慧編碼助理變得很酷之前建構的。 ？因此，許多功能已在各種 IDE 中複製。 AICodeBot 的亮點在於 a) 它位於終端機中，而不是 GUI，b) 它可以在 GitHub actions 等流程中使用。

我們正在使用 AICodeBot 來建造 AICodeBot，並且它一直在螺旋式上升。有關更多信息，請參閱貢獻。

目前功能 - 您今天可以如何使用它

任務	地位
產生品質提交訊息	✅
作為結對程式設計師思考任務	✅
使用少量文件進行編碼	✅
偵錯	✅
進行程式碼審查	✅
解釋程式碼	✅
編寫測試	✅
與 GitHub 集成	✅
修改本地文件	早期階段
在網路上搜尋答案	進行中
閱讀圖書館文檔	早期階段
使用大量文件進行編碼	隨著 LM 獲得更大的代幣限制
編寫高級開發人員級別的程式碼	最終
主要重構	最終
建立整個應用程式	最終
更換開發人員	沒有

人工智慧助手？

aicodebot sidekick您的人工智慧編碼助理。它旨在透過提供上下文感知建議和解決方案來幫助您完成編碼任務。認為 ChatGPT 能夠讀取本機儲存庫以取得上下文。

預設情況下，它將傳遞當前工作目錄中的檔案目錄，您也可以傳遞檔案清單以用作您正在處理的任務的上下文。例如：

aicodebot sidekick file1.py file2.py

在此範例中，sidekick 將讀取 file1.py 和 file2.py 的內容，並使用它們來提供上下文感知的答案。

專業提示：

• 將 README.md 新增至檔案清單以獲得上下文感知答案。
• 貼上日誌檔案或堆疊追蹤中的錯誤訊息，它將幫助您進行偵錯
• 集思廣益新功能
• 讓它為您編寫涵蓋所有情況的單元測試

該功能目前還處於早期階段，但已經很有用了。我們將添加對 sidekick 可以使用的工具的支持，包括 GitHub 整合、提取儲存庫特定領域知識、編寫本地文件等等。目前，它只是讀取文件並提供建議。

AI 輔助的 Git 提交

aicodebot commit改進了 git 提交流程。它將運行預提交來檢查語法，然後根據您所做的更改為您產生提交訊息。只需在提交訊息中輸入“修復錯誤”即可，您將獲得完整描述更改的高品質提交訊息。

人工智慧輔助程式碼審查？

aicodebot review將對您的程式碼進行程式碼審查並提出改進建議。預設情況下，它將查看[un]暫存的更改，您還可以提供特定的提交雜湊來進行審查。它的目標是建議如何使程式碼變得更好，我們發現它經常教導我們有關程式碼的新知識，並使我們成為更好的程式設計師。這是讓第二雙機器人眼睛專注於您的程式碼的好方法。

人工智慧輔助調試 ?

aicodebot debug $command將運行 $command 並捕獲日誌輸出。它將錯誤訊息、堆疊追蹤、命令輸出等傳遞給人工智慧，並給出一些有關如何修復它的建議。

安裝與使用

若要安裝 AICodeBot，請執行：

pip install aicodebot

然後，執行aicodebot configure開始。

Usage: aicodebot [OPTIONS] COMMAND [ARGS]...

Options:
  -V, --version  Show the version and exit.
  -h, --help     Show this message and exit.
  -d, --debug    Enable langchain debug output

Commands:
  alignment       A message from AICodeBot about AI Alignment ❤ + ?.
  commit          Generate a commit message based on your changes.
  configure       Create or update the configuration file
  debug           Run a command and debug the output.
  review          Do a code review, with [un]staged changes, or a...
  sidekick        Coding help from your AI sidekick

API金鑰設定

AICodeBot支援多種大型語言模型，包括Anthropic的Claude 3.x和OpenAI的GPT-3/4x。歡迎 Gemini 或 Ollama 的 Pull 請求，但我們認為這兩個可以解決問題。

第一次執行 AICodeBot 時，系統會提示您輸入 API 金鑰

與 GitHub Actions 集成

每次提交時自動進行程式碼審查怎麼樣？您可以讓 AICodeBot 作為儲存庫上的 GitHub 作業運作。請參閱 AICodeBot GitHub 程式碼審查操作。它將查看每個提交和拉取請求，然後：

• ✅ 透過
• ?️ 評論 - 通過該操作，但留下小問題、建議或改進的評論。
• 失敗操作 - 如果發現嚴重問題，它會留下評論並讓您知道應該解決的問題。

即將推出的功能路線圖️

程式碼工作流程改進

• 輔助 Git 提交：根據您所做的變更自動產生提交訊息
• 輔助偵錯：使用 aicodebot 運行命令，它會捕獲日誌訊息並嘗試從錯誤訊息中找出發生了什麼。最終，它還可以建議修復錯誤並為您進行更改。使用aicodebot debug $command嘗試一下
• 程式碼審查：提供有關程式碼中潛在問題的回饋，並提出改進建議以使其變得更好。
• 依賴管理：透過執行測試的拉取請求將相依性更新到最新版本。
• 文檔產生：產生全面的程式碼文檔，包括文檔字串、自述文件和 wiki 頁面。
• 效能優化建議：建議程式碼的潛在效能最佳化。
• 測試產生：為程式碼產生單元測試，提高測試覆蓋率。
• 與 CI/CD 管道整合：與 CI/CD 管道整合以自動執行程式碼審查、測試和部署等任務（透過 GitHub Actions）。最終：當出現小錯誤時自動修復建置。
• Rubber Ducky 聊天機器人：透過使用目前儲存庫中的資料提供對話介面來討論和解決問題，幫助開發人員思考設計問題。
• Linting/Formatting ：檢查程式碼中的 linting 錯誤並在可能的情況下自動修復它們（透過預先提交）
• 自動產生變更日誌和發行說明：根據提交訊息和程式碼變更產生發行說明和變更日誌。

使用者介面

• 命令列，可透過 pip 安裝：aicodebot 可以使用pip install aicodebot作為 Python 套件安裝
• 提及 @aicodebot GitHub 用戶：在評論中提及 @aicodebot GitHub 用戶將觸發其執行任務、審查程式碼或提取適當的 GIF。
• 可作為 GitHub 操作呼叫：可以作為 GitHub 操作呼叫以在 GitHub 儲存庫上執行任務。 AICodeBot 動作
• Jupyter Notebook Extension ：提供 Jupyter Notebook 擴展，可用於調試筆記本中的程式碼。
• 聊天：CLI 聊天介面，了解程式碼庫的上下文並可以回答有關它的問題。不再需要在 ChatGPT 和命令列之間來回切換。
• Slack Bot ：透過 slack 與 aicodebot 交互，發送通知，執行任務，並為開發人員提供即時協助。
• 錯誤報告服務整合：監聽來自 Sentry、Honeybadger 和其他錯誤報告工具的錯誤報告，並自動建立問題，將其分配給開發人員，並透過 Slack 通知他們。最終：自動修復錯誤並通知團隊。

儲存庫/專案管理

• 專案最佳實務：提出諸如預提交、linting、許可證、CI/CD 等建議。
• 管理 GitHub 問題：提供 GitHub 上傳入問題的 1 級分類，包括標記、分配和回應常見問題。它還可以在必要時將問題升級給人類開發人員，並為需要更多輸入的任務提供提示。
• 歡迎新貢獻者：自動歡迎新貢獻者加入項目，找出他們感興趣的內容，並建議他們解決的問題。

樂趣

• 一致性：傳達了一條以心靈為中心的鼓舞人心的信息，告訴我們如何以與人性一致的方式建構人工智慧。嘗試使用aicodebot alignment 。
• 講笑話：我們必須弄清楚如何教導有關幽默的語言模式。 :)
• 支持性鼓勵：對出色的工作擊掌並表示讚揚
• GIF 反應：使用相關且有趣的 GIF 對訊息做出反應。

對齊❤️ + ?

科技本身是不道德的；它只是灌輸了創造它的人的價值觀。我們相信人工智慧應該以一種與人性一致的方式構建，我們正在構建 AICodeBot 來幫助我們做到這一點。我們正在建立一個以心為中心的空間，並為人工智慧與人類的健康交叉做出貢獻。

它不是什麼

aicodebot是開發人員的工具，而不是他們的替代品。它不會取代您的工作，但會讓您的工作變得更輕鬆、更有趣。它不會接管世界，但會幫助我們建立一個更美好的世界。有關更多信息，請參閱下面的對齊部分。

️ AICodeBot 目前使用 OpenAI 的 ChatGPT 大語言模型，該模型可以產生幻覺並自信地錯誤。有時 AICodeBot 會做一些愚蠢的事情，所以它主要是閱讀和建議，而不是寫作。就像特斯拉的「全自動駕駛」一樣，你必須把手放在方向盤上。

它也不是一個「5 分鐘內為我建立一個網站」的工具，它需要一個精心構建的提示並為您建立一個腳手架。還有其他工具可以實現這一點。它不是一個無程式碼平台。相反，AICodeBot 旨在與現有程式碼庫和 git 提交等級配合使用。它旨在提高有能力的工程師的效率。

配置要使用的語言模型

若要指定不同的模型，您可以在$HOME/.aicodebot.yaml檔案中設定language_model 。例如：

 openai_api_key : sk-*****
language_model : gpt-3.5-turbo
personality : Stewie
version : 1.3

理解令牌並有效使用命令

在 OpenAI 的 GPT-4 等人工智慧模型中，「令牌」是一段文本，短如字元或長如單字。 API 呼叫中的總令牌（包括輸入和輸出）會影響成本、時間以及呼叫是否基於最大限制進行。

每個模型都有最大代幣限制。例如，GPT-3.5 的代幣限制為 4096 個代幣，GPT-4 的代幣限制為 8192 個代幣。如果對話超出此限制，您必須減少文字直至適合。

當使用 AICodeBot 中的 Sidekick 命令（允許您傳入上下文檔案）等命令時，有效管理令牌非常重要。由於令牌限制，載入整個程式碼庫是不可行的。相反，您應該只載入與您正在處理的任務相關的特定檔案。這確保了人工智慧模型可以有效地處理您的請求，並為您當前的任務提供最相關的建議。

如何獲得更大的代幣限額？

您的任務需要更大的上下文視窗嗎？您是否遇到了令牌限制並收到這樣的訊息？

The context is too large (21414) for any of the models supported by your API key. ?

您可以執行以下幾項操作：

1. 將更少的文件加載到上下文中（僅加載您需要使用的文件）
2. 使用 Anthropic 的 Claude，它具有更大的上下文窗口

開發/貢獻

我們希望得到您的幫助！如果您有興趣做出貢獻，請按照以下步驟開始。有關更多詳細信息，請參閱貢獻。

碼頭工人

假設您已新增目前工作目錄中的變更。

docker build -t aicodebot .
docker run -v ~ /.aicodebot.yaml:/home/user/.aicodebot.yaml -v .:/app aicodebot commit -y