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