Vibemode 项目安装与配置指南

1. 项目基础介绍

Vibemode 是一个命令行界面（CLI）工具，旨在帮助开发者将代码库打包成 AI 友好的格式，并能够将 AI 提出的代码更改轻松应用到本地文件中。这个工具特别适用于那些直接使用大型语言模型（LLM）进行编码的场景，例如通过 ChatGPT UI 或 AI Studio 等。

项目主要使用的编程语言是 JavaScript。

2. 项目使用的关键技术和框架

• Glob 模式: 用于文件和目录的选择。
• Gitignore 支持: 自动遵循 .gitignore 文件中的规则。
• XML 格式输出: 生成包含目录结构和文件内容的结构化 XML。
• Gemini API: 用于理解并应用 AI 生成的代码更改。

3. 项目安装和配置准备工作

在开始安装 Vibemode 之前，请确保您的系统中已经安装了以下工具：

• Node.js: Vibemode 是基于 Node.js 开发的，确保安装了 Node.js 环境。
• npm 或 yarn: 用于管理项目依赖。
• 终端或命令提示符: 用于运行 Vibemode 命令。

安装步骤

1. 获取 Vibemode

   打开终端或命令提示符，运行以下命令来下载 Vibemode：

   npx vibemode
   

   使用 npx 可以在不全局安装的情况下直接运行 Vibemode。

2. 配置环境变量（可选）

   如果您打算使用 Vibemode 的“Apply edits”功能，您需要一个 Gemini API Key。按照以下步骤操作：

   • 访问 Google AI Studio 获取免费的 API Key。
   • 将获取到的 API Key 设置为环境变量 GEMINI_KEY。

   对于不同的操作系统，设置环境变量的命令如下：

   • Linux/macOS

     export GEMINI_KEY='YOUR_API_KEY_HERE'
     

   • Windows（命令提示符）

     set GEMINI_KEY=YOUR_API_KEY_HERE
     

   • Windows（PowerShell）

     $env:GEMINI_KEY='YOUR_API_KEY_HERE'
     

3. 使用 Vibemode

   • 打包文件

     运行 Vibemode 后，选择“Pack files”选项。使用 glob 模式或直接输入文件/目录名称来选择要打包的内容。完成后，按 Enter 键将打包的 XML 复制到剪贴板。

   • 应用更改

     如果您有 AI 生成的代码更改，选择“Apply edits”选项，并将 AI 的响应粘贴到提示中。Vibemode 会解析并尝试将这些更改应用到您的本地文件。

以上就是 Vibemode 的详细安装和配置指南。祝您使用愉快！