--- theme: cyanosis ---

CodeLLMs-AI

👉 利用 AI 洞察力增强您的代码能力💘 👈

** ## 介绍 🌟 写这个插件的目的主要是两个 * 为了开发一个工作辅助工具，方便去阅读代码和快速写总结文档 * 为了学习如何开发一款VSCode插件这款插件目前已经在插件市场可下载使用，[插件地址](https://marketplace.visualstudio.com/items?itemName=codellms.codellms-ai) 当然，目前Copilot是最好，也是最热门的AI辅助工具，能满足日常的要求，但是Copilot并没有很好支持在代码的基础上直接添加注释或者基于代码的语言转换。CodeLLMs在大模型的基础上，能够将这两个功能切合进日常工作当中，并且允许用户自定义模型，给予最大程度的用户选择体验。后续我将对插件进行拆解，将这个过程中遇到的问题和解决方案分享到社区当中，有兴趣的同学可以关注一波。至于开源情况，目前暂不打算开源，主要是因为后续可能还会接入一些其他功能，待功能完善后再考虑公开代码。 ## 主要技术栈 ✏️ * TypeScipt 几乎所有的代码都是用ts写的 ## 特点 💥

* ☀️ **代码注释工具（CodeComment）**：一键为代码添加注释，制作文档和理解代码的最佳帮手 ![image.png](https://p6-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/3f350296e22c45e491db1898dd4b2546~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg56eR56CB5bCP55m9:q75.awebp?rk3s=f64ab15b&x-expires=1761650887&x-signature=VUx%2FonInz9rxrVtphvx73ILEsDA%3D) * 🐱 **语言转换工具（CodeConvert）**：一键转换代码语言，转换的代码的第三方库和依赖会尽可能的保留其作用，并且能够正确执行 ![image.png](https://p6-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/ba906c2913554908b399e036e118f140~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg56eR56CB5bCP55m9:q75.awebp?rk3s=f64ab15b&x-expires=1761650887&x-signature=GGfOgslAfbwvhZzNy34VRVvUrqA%3D) * 🐧 **代码补全助手（CodeCompletion）**：一键补全后续代码，在代码中以注释写明需求效果更佳，会充分理解模块的作用并且补全工程性代码 ![image.png](https://p6-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/cc4dee33d3784f6ebbbed68b991321e7~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg56eR56CB5bCP55m9:q75.awebp?rk3s=f64ab15b&x-expires=1761650887&x-signature=MPMvNQyXXP9qx3YAOFwIvomW%2BZ8%3D) * 🐼 **代码 Prompt 提示（CodePrompt）**：支持选择需要咨询的代码并结合咨询的内容向大模型提问 * 🐒 **支持多模型**：支持当前市面上的大部分大模型（Comming soon） ## 支持模型 🔔 目前支持下列模型，其他模型正在探索中，很多模型国内不便使用，所探索的模型都希望于国内较容易获取到 key，并且有一点的免费额度。极力推荐 Google Gemini 模型，不仅表现优秀，而且有足够的免费额度使用，是一个比 OpenAI-GPT 更优的选择\~ * **Google Gemini**: * **OpenAI**: * **通义千问**： * **智谱**： ## 安装 💼 * 打开 Visual Studio Code * 进入扩展 (Ctrl+Shift+X) * 搜索 **"CodeLLMs-AI"** * 点击安装 ## 使用/配置 📱 * 打开扩展配置（Ctrl+Shift+X 然后点击扩展设置） * 或者：打开设置，搜索：codellms，左边树形菜单栏选择扩展——CodeLLMs-AI * 需要配置的项有： * **Ai Key**：需要使用的大模型 key，自行前往相关模型 API 控制台申请（上述模型列表已给出 API 申请地址） * **Default Model**：需要选择的大模型，对应的模型列表参数如下（只需在此处填写模型列表对应的英文和拼音名称） * Google Gemini: **gemini** * OpenAI: **openai** * 通义千问: **tongyi** * 智谱: **zhipu** * **Proxy**：系统代理，国外模型需要开启代理才能使用功能。代理设置如： (你的代理端口)，插件内支持自动获取系统代理，可以在开启系统代理后重启VSCode以及插件，如果还是不行，就去扩展配置中设置proxy选项为自己的代理接口 * 注意事项上述均设置了依然未能正常使用，检查如下： * key 值不对 * 模型选择不对 * 切换不同的代理节点 * 配置完成后重启插件试试 ## 后续计划（开坑） 📃 对项目进行拆解，作为技术点分享，包括但不限于：如何开发和发布一款VSCode插件、如何对VScode的窗口进行设置和操作，如何对大模型进行请求，如何解析大模型的回复，如何获取系统代理并且挂载到全局fetch中等等 **有任何使用问题和新增功能的想法，欢迎评论私信我！**