🪄StarShip CodeSouler——您的智能Coding伴侣
StarShip CodeSouler是由OpenCSG推出的一款由最新大模型技术驱动的编程插件，从生成测试到编写和审查代码，CodeSouler提供了一套工具来提高效率、提高代码质量和简化开发过程，旨在优化您的软件开发周期。
✨快速开始
💫CodeSouler能做什么
-
智能代码注释:CodeSouler能够自动分析代码逻辑，并为其添加准确、详尽的注释。无论是变量命名、函数作用还是复杂的逻辑判断，插件都能准确捕捉并生成易于理解的注释内容，帮助开发者和团队成员快速理解代码意图，减少沟通成本。
-
智能代码补全：CodeSouler 能够根据当前代码的上下文，实时预测您接下来可能要编写的代码， 并以灰色文本形式给出建议。无论是单个变量、一行代码，还是完整的函数或类，您只需按下 Tab 键即可快速应用补全建议，从而大幅提升编码速度、减少重复性劳动，并有效避免常见错误。
-
代码优化重构:CodeSouler能够自动识别并建议代码中的优化点，如冗余代码移除、变量命名优化、循环简化等。同时，针对常见的代码错误和性能瓶颈，插件还能提供即时的修复建议和重构方案，帮助开发者轻松提升代码质量和运行效率。
-
测试用例生成：CodeSouler可以自动生成针对您的代码库量身定制的全面测试套件，这些测试用例覆盖了代码的主要路径和边界情况，确保代码在修改和扩展过程中始终保持稳定可靠。
-
项目代码交互问答:CodeSouler可以将实时解析用户基于任意项目代码或文件内容的提问，并基于项目和文件内容给出准确的回答和建议。无论是关于代码逻辑、函数作用还是项目架构的疑问，CodeSouler都能提供及时、专业的解答，帮助开发者快速解决问题，提高开发效率。
🗝️快速上手
CodeSouler允许您采用不同的方式来实现对代码的操作，具体支持以下方式：
1. 选中代码块后鼠标右击
选中要操作的目标代码块，点击鼠标右键后选择CodeSouler，即可对目标代码库进行添加注释、优化重构等操作。
各个菜单功能说明如下：
| 名称 | 操作说明 |
|---|---|
| Add highlight code to context | 将选中代码添加到对话框上下文 |
| Edit Code | 内联编辑 |
| Fix Grammar / Spelling | 修复语法及拼写错误 |
| Fix this code | 修复选中代码 |
| Optimize this code | 优化选中代码 |
| Write a docstring for this code | 为选中代码撰写功能描述 |
| Write comments for this code | 为选中代码添加注释 |
2. 内联编辑
选中代码后点击“内联编辑”菜单或使用 Ctrl + L快捷键，在弹出的窗口中输入编辑需求，即可快速修改选中的代码段。
3. 使用CodeSouler会话框
(1)唤起会话框
- VSCode：使用
Ctrl + L / Command + L即可唤出会话窗口；在选中代码块后使用Ctrl + L / Command + L快捷键，即可将代码段上下文快速添加至会话框内。 - JetBrain：使用
Ctrl + J / Command + J即可唤出会话窗口；在选中代码块后使用Ctrl + J / Command + J快捷键，即可将代码段上下文快速添加至会话框内。
(2)插入代码
- 在会话窗口中点击'Apply'按钮,CodeSouler就会将代码段插入到当前文件的指定位置，并显示Diff。
(3)操作指令
-
CodeSouler实现了一套完整的操作指令，用户只需唤起会话框后组合指令，即可快速发送需求。
-
目前主要包含三种操作符：
- "@" 指令：引用Agent
- "+" 指令：引用对象
- "/" 指令：具体操作
完整的操作方法及功能说明如下表所示：
| 操作方法 | 名称 | 操作说明 |
|---|---|---|
| 操作名称"/" | edit | 编辑选中代码 |
| test | 对选中代码进行单元测试 | |
| codereview | 进行代码审查 | |
| secscan | 对代码进行安全扫描 | |
| 引用对象"+" | Files | 引用文件 |
| Code | 引用代码段 | |
| Docs | 引用文档 | |
| Git Diff | 代码修改差异 | |
| Terminal | 引用终端内容 | |
| Problems | 引用当前文件中的问题 | |
| Folder | 引用文件夹 | |
| Codebase | 自动识别并引用相关代码，优先检索最近打开的文件 | |
| GitLab Issues | 引用当前用户有关的issue | |
| GitLab Users | 引用当前Gitlab User | |
| GitLab Merge Requests | 引用当 前用户有关的 Merge Request | |
| Local Docs | 引用当前项目下.codesouler/docs中的文档 | |
| MCP Servers | 引用当前用户注册的MCP |
(4)任务执行与控制
当CodeSouler的建议涉及执行终端命令时（例如安装依赖、运行脚本），会直接调用VSCode的集成终端来执行任务。此时，一个交互式的控制面板会出现在您的界面上，提供以下操作选项：
| 功能 | 说明 |
|---|---|
| 运行 (Run) | 执行当前CodeSouler建议的命令或应用代码修改。当您审查并确认CodeSouler提出的单步操作无误后，点击此按钮以立即执行。 |
| 跳过 (Skip) | 放弃当前建议，继续处理下一个任务。如果您认为当前建议不正确或不必要，点击此按钮可忽略该步骤。 |
| 自动批准 (Auto-Approve) | 自动批准并执行CodeSouler在当前任务中的所有后续步骤。启用后，CodeSouler将连续执行所有操作，无需您手动确认每一步。请谨慎使用。 |
| 后台运行 (Proceed While Running) | 在后台执行耗时命令，同时允许您继续其他工作。适用于编译、安装大型依赖等耗时任务，可避免阻塞界面。 |
| 终止命令 (Kill Command) | 强制停止当前正在后台执行的命令。如果后台命令卡住、出错或不再需要，点击此按钮可立即终止该进程。 |
4. 修改语言
- CodeSouler支持切换文本/注释的语言，点击“设置”按钮，在设置页面中切换。
