Vibemode 项目使用教程

1. 项目目录结构及介绍

Vibemode 项目是一个命令行界面（CLI）工具，旨在帮助开发者将代码库打包成适合 AI 消费的结构化 XML 格式，并能够将 AI 生成的代码更改直接应用到本地文件。以下是项目的目录结构及其简要介绍：

vibemode/
├── .gitattributes
├── .gitignore
├── .prettierignore
├── .vscode
├── LICENSE.MD
├── README.md
├── bundle.js
├── logo.png
├── package-lock.json
├── package.json
├── preview.gif
├── source/
│   └── ...
├── testfixtures/
│   └── ...
├── test.js

• .gitattributes: 定义如何处理特定文件的 Git 属性。
• .gitignore: 指定 Git 应忽略的文件和目录。
• .prettierignore: 指定 Prettier 应忽略的文件。
• .vscode: Visual Studio Code 的配置文件。
• LICENSE.MD: 项目的 Apache-2.0 许可证文件。
• README.md: 项目的自述文件。
• bundle.js: 打包后的 JavaScript 文件。
• logo.png: 项目图标。
• package-lock.json: npm 依赖项锁定文件。
• package.json: 定义项目的元数据和依赖项。
• preview.gif: 预览图。
• source/: 源代码目录。
• testfixtures/: 测试用例目录。
• test.js: 测试脚本。

2. 项目的启动文件介绍

package.json 文件包含了项目的元数据和启动脚本。以下是启动 vibemode 的基本命令：

npx vibemode

运行此命令将启动 CLI 工具，并提供以下选项：

• Pack files: 选择并打包文件或目录。
• Apply edits: 应用 AI 生成的代码更改。

3. 项目的配置文件介绍

package.json 文件中的 scripts 部分 可以包含用于启动和运行项目的脚本。vibemode 不需要特殊的配置文件，因为它是一个直接通过命令行运行的工具。然而，如果需要使用 Apply edits 功能，需要配置环境变量 GEMINI_KEY，该变量包含用于访问 Google Gemini API 的密钥。

以下是如何在不同操作系统上设置 GEMINI_KEY 的示例：

• Linux/macOS:

export GEMINI_KEY='YOUR_API_KEY_HERE'

• Windows (Command Prompt):

set GEMINI_KEY=YOUR_API_KEY_HERE

• Windows (PowerShell):

$env:GEMINI_KEY='YOUR_API_KEY_HERE'

确保在尝试使用 Apply edits 功能之前设置好此环境变量。