CatCode AI Assistant 🤖
CatCode AI Assistant 是一个强大的 VSCode 扩展，为您提供智能代码生成、任务规划、代码重构建议和无缝工作区集成的 AI 编程助手。
🎉 v4.0.0 重大更新 - 工作流革命
🚀 全新规范驱动工作流系统
v4.0.0 带来了革命性的规范驱动工作流功能，让 AI 不仅是代码助手，更成为您的项目架构师和开发伙伴！
核心亮点
- 🎯 27个精细化开发阶段：从需求分析到项目交付的完整生命周期管理
- 🤖 AI智能项目生成：基于需求自动生成完整项目代码和文档
- 📋 交互式需求完善：AI引导式需求收集，确保项目目标清晰
- 🏗️ 自动化架构设计：生成系统架构图、数据模型、API设计
- 💻 一键项目生成：自动创建项目结构、代码文件、配置文件
- 📚 完整文档输出：自动生成需求文档、技术规范、部署指南
工作流特性
- ✨ 智能需求分析：深度理解用户意图，生成详细需求规格
- 🔄 迭代式完善：支持随时修改和调整，AI即时响应
- 🎨 美化UI交互：玻璃态设计，流畅的动画效果
- 📊 实时状态反馈：清晰的阶段指示和进度展示
- 🔧 灵活可控：支持确认、修改、返回等交互操作
🆕 其他新增功能
- 直接项目生成：移除模板选择，直接基于AI生成最优方案
- 增强的消息管理：优化的会话系统，支持多轮对话
- 改进的UI体验：深色主题优化，更美观的交互界面
✨ 主要特性
核心功能
- 🚀 规范驱动工作流 - 从需求到代码的全流程 AI 驱动开发
- 🤖 智能代码生成 - AI 驱动的代码自动完成和生成
- 🎯 任务规划 - 将复杂需求分解为可执行的步骤
- 💡 代码智能提示 - 悬停和 CodeLens 提供即时帮助
- ⚡ 快速操作 - 丰富的快捷键和右键菜单
代码质量
- 📊 代码质量分析 - 实时代码检查和建议
- ♻️ 代码重构助手 - 智能重构建议和自动应用
- 🧪 测试生成 - 自动生成单元测试代码
- 📝 智能注释 - 自动添加代码注释和文档
项目管理
- 📁 智能文件扫描 - 高性能项目文件分析
- 🔧 工作区状态管理 - 自动保存和恢复会话
- 📚 片段管理 - 个人代码库管理
- 🌍 多语言支持 - 中英文界面随意切换
🚀 快速开始
1. 安装扩展
- 打开 VSCode
- 按
Ctrl+Shift+X 打开扩展面板
- 搜索 "CatCode AI Assistant"
- 点击 "Install" 安装
2. 获取 API 密钥
重要：使用前必须配置 API 密钥！
📱 微信获取步骤：
- 打开微信，搜索公众号：肥猫 ai
- 关注公众号后，发送任意消息
- 公众号会回复您的专属 API 密钥
- 复制密钥备用
3. 配置 API 密钥
方法一：通过设置界面
- 按
Ctrl+, 打开设置
- 搜索 "catcode.apiKey"
- 将获取的密钥粘贴到输入框中
- 保存设置
方法二：通过命令面板
- 按
Ctrl+Shift+P 打开命令面板
- 输入 "Open Settings"
- 搜索 "catcode.apiKey" 并配置
🎯 功能使用指南
🌟 规范驱动工作流（新功能）
启动工作流
- 打开 CatCode 主面板
- 选择 "规范驱动工作流" 模式
- 输入项目需求描述
- AI 将自动启动 27 个阶段的开发流程
工作流阶段详解
需求分析阶段（7个子阶段）
- 需求收集与整理
- 用户故事定义
- 功能需求分析
- 非功能需求定义
- 需求优先级排序
- 需求可行性评估
- 需求确认与基线
系统设计阶段（7个子阶段）
- 系统架构设计
- 数据库设计
- API接口设计
- 前端架构设计
- 安全设计
- 性能设计
- 部署架构设计
开发实施阶段（6个子阶段）
- 开发环境搭建
- 核心功能开发
- 前端界面开发
- 后端服务开发
- 数据库实现
- API接口实现
测试验证阶段（4个子阶段）
部署交付阶段（3个子阶段）
交互操作
每个阶段完成后，您可以：
- ✅ 确认继续：接受当前结果，进入下一阶段
- ✏️ 修改内容：提供修改意见，AI重新生成
- ↩️ 返回上一步：回到上一个阶段重新处理
快捷键操作
| 快捷键 |
功能 |
说明 |
Ctrl+Shift+C |
快速对话 |
打开快速输入框进行 AI 对话 |
Ctrl+Shift+E |
解释代码 |
解释当前选中的代码块 |
Ctrl+Shift+O |
优化代码 |
优化选中的代码结构和性能 |
Ctrl+Shift+T |
生成测试 |
为选中代码生成单元测试 |
Ctrl+Shift+S |
保存代码片段 |
将选中代码保存为片段 |
Ctrl+Shift+I |
插入代码片段 |
插入已保存的代码片段 |
Ctrl+Shift+R |
显示重构建议 |
显示当前文件的重构建议 |
命令面板操作
按 Ctrl+Shift+P 打开命令面板，输入以下命令：
CatCode: 打开CatCode助手 - 打开主面板CatCode: 启动规范驱动工作流 - 启动工作流模式CatCode: 快速对话 - 启动快速对话模式CatCode: 解释选中的代码 - 解释选中代码CatCode: 优化选中的代码 - 优化代码结构CatCode: 为选中代码生成测试 - 自动生成单元测试CatCode: 为选中代码添加注释 - 添加详细注释CatCode: 保存代码片段 - 保存当前选中代码CatCode: 插入代码片段 - 插入已保存的片段CatCode: 导出代码片段 - 导出所有片段CatCode: 导入代码片段 - 导入片段集合CatCode: 更改语言/Change Language - 切换界面语言CatCode: 显示重构建议 - 分析并显示重构建议CatCode: 刷新文件列表 - 重新扫描项目文件
右键菜单操作
选中代码后右键，在菜单中找到 CatCode 选项：
- 🤖 解释代码
- ⚡ 优化代码
- 🧪 生成测试
- 📝 添加注释
- 💾 保存为片段
- ♻️ 重构建议
🛠️ 高级配置
在 VSCode 设置中搜索 "catcode" 可找到以下配置选项：
{
// API 密钥配置
"catcode.apiKey": "your-api-key-here",
// 启用/禁用智能代码提示
"catcode.autoSuggest": true,
// 默认使用的 AI 模型
"catcode.defaultModel": "gemini-2.5-flash",
// 文件扫描大小限制（字节）
"catcode.maxFileSize": 1048576,
// 界面语言设置
"catcode.language": "auto", // auto, zh-cn, en
// 启用重构建议
"catcode.enableRefactoringSuggestions": true,
// 保存时自动分析
"catcode.analysisOnSave": true,
// 启用代码片段快捷键
"catcode.snippetShortcuts": true,
// 启用工作流功能
"catcode.enableWorkflow": true
}
模型选择
支持以下 AI 模型：
gemini-2.5-flash - 快速响应，适合日常使用gemini-2.5-pro - 高质量输出，适合复杂任务gemini-2.0-flash - 平衡性能，通用选择
📊 使用场景
🚀 规范驱动工作流
示例需求：
"开发一个在线任务管理系统，支持用户注册登录、任务创建编辑、团队协作"
AI 将自动：
1. 分析需求，生成详细规格
2. 设计系统架构和数据模型
3. 生成前后端代码
4. 创建测试用例
5. 提供部署方案
🔍 代码解释
// 选中这段代码，按 Ctrl+Shift+E
function fibonacci(n) {
if (n <= 1) return n;
return fibonacci(n - 1) + fibonacci(n - 2);
}
⚡ 代码优化
# 选中需要优化的代码，按 Ctrl+Shift+O
def process_data(data):
result = []
for i in range(len(data)):
if (data[i] > 0):
result.append(data[i] * 2)
return result
🧪 测试生成
// 为这个函数生成测试，按 Ctrl+Shift+T
export function validateEmail(email: string): boolean {
const regex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
return regex.test(email);
}
🎮 界面介绍
主面板功能
- 开发模式选择：规范驱动工作流 / 规划与执行 / 迭代开发
- 工作流控制：启动、暂停、修改工作流
- 文件选择器：快速选择项目文件
- 聊天区域：与 AI 助手对话
- 代码预览：查看生成的代码
- 片段管理：管理个人代码库
工作流界面
- 阶段指示器：显示当前进行的开发阶段
- 交互按钮：确认、修改、返回操作
- 实时反馈：AI生成内容的实时展示
- 修改对话框：优雅的玻璃态设计输入界面
状态栏信息
- 🟢 绿色：API 密钥已配置且有效
- 🟡 黄色：正在处理中
- 🔴 红色：需要配置 API 密钥或发生错误
- 🚀 紫色：工作流运行中
🔧 故障排除
常见问题
Q: 工作流无法启动？
A:
- 确认 API 密钥已正确配置
- 检查网络连接是否正常
- 查看输出面板的错误信息
Q: 生成的项目文件在哪里？
A:
- 项目文件会自动保存到当前工作区
- 检查文件资源管理器中的新文件
- 查看输出面板的文件保存路径
Q: 如何修改已生成的内容？
A:
- 点击"修改内容"按钮
- 在弹出的对话框中输入修改意见
- AI 会根据您的反馈重新生成
Q: API 密钥配置后仍显示错误？
A:
- 检查密钥格式是否正确
- 确认密钥未过期
- 重新从微信公众号获取新密钥
获取帮助
- 查看输出面板（View → Output → CatCode）
- 检查开发者工具控制台
- 通过微信公众号 肥猫 ai 联系获取支持
🌟 最佳实践
使用工作流的建议
- 清晰描述需求：提供详细的项目需求描述
- 逐步确认：每个阶段仔细审查 AI 生成的内容
- 及时修改：发现问题立即使用修改功能调整
- 保存重要内容：将生成的文档和代码及时保存
提高使用效率
- 合理使用快捷键：熟记常用快捷键提高操作速度
- 选择合适模型：日常使用 Flash，复杂任务用 Pro
- 分步骤操作：将大任务分解为小步骤处理
- 利用上下文：选择相关文件提供更好的上下文
- 建立片段库：保存常用代码片段提高复用
📈 版本更新
v4.0.0 (最新) - 2024年12月
- 🚀 新增规范驱动工作流系统
- 27个精细化开发阶段
- 交互式需求完善
- 自动项目生成
- 完整文档输出
- 🎨 UI全面升级
- 🔧 功能优化
- 移除模板选择，直接AI生成
- 改进的会话管理
- 增强的错误处理
v3.0.0
- ✨ 新增增强代码分析器
- ♻️ 新增智能重构建议系统
- 📚 新增代码片段管理器
- 🌍 新增国际化支持
- ⚡ 性能大幅优化
v2.1.0
- ✨ 新增智能 Hover 和 CodeLens 提示
- 🚀 文件扫描性能提升 300-500%
- 🛠️ 完善的错误处理和用户反馈
- 💾 工作区状态管理和自动保存
- 📊 新增代码分析面板
📜 许可证
本项目基于 MIT 许可证开源 - 详见 LICENSE 文件
🙏 致谢
感谢所有使用 CatCode AI Assistant 的开发者！您的反馈和建议让这个工具变得更好。
特别感谢 v4.0.0 版本的早期测试用户，您们的宝贵意见帮助我们打造了革命性的工作流系统。
📞 联系我们
- API 密钥获取：微信搜索公众号 肥猫 ai
- 技术支持：通过公众号联系我们
- 问题反馈：欢迎通过公众号或 GitHub 提交问题
- 功能建议：我们期待您的创意和想法
开始您的 AI 驱动开发之旅吧！ 🚀
使用全新的规范驱动工作流，让 AI 成为您的架构师和开发伙伴，从需求到代码，一键生成完整项目！
如有问题，欢迎通过微信公众号 肥猫 ai 联系我们获取支持。
