Kaguya

Kaguya 是一个 ChatGPT 插件，允许你以受控的方式加载和编辑本地文件，并运行任何 Python、JavaScript 和 Bash 脚本。这使其成为开发人员的强大工具，使他们能够直接从 ChatGPT 与文件系统交互并运行脚本。要使用 Kaguya，你需要通过加入他们的等待名单来获取插件开发工具的访问权限 这里。如果这种方法对你不起作用，我们可能会在未来的某个时候推出一种更开放的方式。

演示

以下是 Kaguya 的几段演示视频：

https://github.com/ykdojo/kaguya/assets/107422421/c580a6f6-5f08-43fd-ac8b-c12a319e1534

https://github.com/ykdojo/kaguya/assets/107422421/d61b8ff1-2dbd-4eb4-b1b5-45d43797ddaa

入门指南

1. 在 这里 获取 OpenAI 的 ChatGPT 插件开发工具访问权限。
2. 安装 Docker 并在本地运行。
3. 将此仓库克隆到你的本地环境。
4. 执行 docker.sh 脚本。
5. 设置本地主机端口 3000。
6. 通过 ChatGPT 与 Kaguya 交互。
7. 如果你希望 Kaguya 能够与你的文件交互，请将它们放入 FILES 文件夹中。
8. 注意：Kaguya 无法访问其自身目录之外的文件。

推荐的自定义指令

编辑文件时，请使用搜索和替换功能，除非处理的是非常小的文件，否则不要使用 updateWholeFile。在编辑文件之前，请先与我确认。

当 Kaguya 提供输出时，无需重复其中的所有内容，你可以对其进行简洁的总结。

当你需要在子目录中使用 executeCommand 时，每次都要先切换到该目录。

API 端点

该项目提供了多个 API 端点，允许你在 Kaguya 目录内与文件系统交互。API 的详细说明见 openapi.yaml 文件。以下是简要概述：

• GET /api/listFilesInDirectory：列出指定目录中的文件和子目录，默认为 FILES 目录。
• GET /api/readFile：读取用户目录中某个文件的内容。
• GET /api/readMultipleFiles：读取多个文件的内容。
• POST /api/update：通过搜索和替换操作更新用户目录中的文件。
• POST /api/updateAll：通过搜索和替换操作更新用户目录中的文件（所有匹配项）。
• POST /api/updateWholeFile：替换用户目录中某个文件的全部内容。
• POST /api/appendToFile：将内容追加到现有文件的末尾。
• POST /api/createFile：创建新文件。
• POST /api/deleteFile：删除用户目录中的文件。
• POST /api/renameFile：重命名用户目录中的文件。
• POST /api/createDirectory：创建新目录。
• POST /api/deleteDirectory：删除目录及其内容。
• POST /api/executeCommand：执行 shell 命令。

小贴士

• 如果 listFilesInDirectory 尝试显示过多文件，一个好的解决办法是添加一个 Git 仓库或子模块，这样 .gitignore 中的文件就会被忽略。
• 最好将每个文件保持在 100 行代码以下，尤其是在编写代码时。
• 不建议一次编写超过约 80 行代码，因为这样会很慢，甚至可能无法完成任务。
• 你可以让它读取更多的代码，但不建议一次读取超过 500–600 行代码。
• 如果你要编辑的目标文件较长，可以明确要求它使用搜索和替换功能，而不是 updateWholeFile。
• 它可能不会立即理解你的意图，因为它是一个对话式工具。
• 如果助手开始出现幻觉，可以尝试开启一个新的对话，或者限制每次加载的文件长度。

Discord

欢迎加入我们的 Discord 服务器 这里。

VS Code 扩展

我们也在开发 Kaguya 的 VS Code 扩展版本。欢迎在此处注册等待名单 这里。

Kaguya 快速上手指南

Kaguya 是一款强大的 ChatGPT 插件，允许你在受控环境下加载、编辑本地文件，并直接运行 Python、JavaScript 和 Bash 脚本。它让开发者能够通过自然语言与文件系统交互，极大提升开发效率。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：支持 Docker 的系统（Windows, macOS, Linux）。
• 核心依赖：
  • Docker：必须安装并正在本地运行。
  • ChatGPT 插件开发权限：你需要加入 OpenAI 的插件开发者等待列表以获得访问权限。
    • 申请地址：https://openai.com/waitlist/plugins
• 网络环境：由于涉及连接 OpenAI 服务，请确保网络通畅（国内用户可能需要自行配置网络代理）。

安装步骤

按照以下步骤在本地部署 Kaguya：

1. 克隆项目仓库 将 Kaguya 源码克隆到本地环境：

   git clone https://github.com/ykdojo/kaguya.git
   cd kaguya
   

2. 启动 Docker 容器 执行提供的脚本以构建并运行容器：

   ./docker.sh
   

   (注：Windows PowerShell 用户可能需要运行 .\docker.sh 或在 Git Bash 中运行)

3. 配置端口映射 确保本地 3000 端口已正确映射并可供访问。Kaguya 服务将在此端口运行。

4. 准备文件目录 若需让 Kaguya 操作特定文件，请将它们放入项目根目录下的 FILES 文件夹中。

   注意：出于安全考虑，Kaguya 默认只能访问其自身目录内的文件，无法操作外部路径。

5. 启用插件 在 ChatGPT 界面中，进入插件商店（Plugin Store），搜索并启用 "Kaguya"（需先完成上述等待列表申请并通过审核）。

基本使用

1. 推荐自定义指令 (Custom Instructions)

为了获得最佳体验，建议在 ChatGPT 的 "Custom Instructions" 或对话开头填入以下指令，以规范其行为：

When editing a file, use search and replace and NOT updateWholeFile unless we're dealing with a very small file. Confirm with me before you edit a file.

When you have output from Kaguya, there's no need to repeat everything from there. Instead, you can summarize it concisely.

When you want to use executeCommand in a subdirectory, make sure to cd there first every time.

2. 使用示例

场景一：读取并分析代码

用户提示词： "List the files in the FILES directory and read the content of main.py. Summarize what this script does."

预期行为：Kaguya 调用 listFilesInDirectory 和 readFile 接口，返回文件列表及 main.py 的功能摘要。

场景二：修改文件内容

用户提示词： "In config.json, change the value of 'timeout' from 30 to 60. Please confirm before making the change."

预期行为：Kaguya 会使用 search-and-replace 策略定位修改点，并在执行前向你确认。

场景三：运行脚本

用户提示词： "Navigate to the scripts folder and run build.sh."

预期行为：Kaguya 先执行 cd scripts，然后调用 executeCommand 运行脚本，并返回执行结果摘要。

3. 高效使用技巧

• 文件大小限制：建议单个文件代码行数控制在 100 行以内进行写入操作；读取操作尽量不超过 500-600 行，以免响应超时或失败。
• 编辑长文件：对于长文件，务必明确指示 AI 使用 "search and replace" 而非 "updateWholeFile"。
• 避免幻觉：如果 AI 开始产生幻觉或理解偏差，尝试开启新对话或减少单次加载的文件数量。
• 大目录处理：如果文件列表过长，建议在目录中初始化 git 仓库并利用 .gitignore 过滤无关文件。