CodeShell VSCode Extension

codeshell-vscode项目是基于CodeShell大模型开发的支持Visual Studio Code的智能编码助手插件，支持python、java、c++/c、javascript、go等多种编程语言，为开发者提供代码补全、代码解释、代码优化、注释生成、对话问答等功能，旨在通过智能化的方式帮助开发者提高编程效率。

环境要求

• node版本要要v18及以上
• Visual Studio Code版本要求 1.68 及以上
• CodeShell 模型服务已启动

编译插件

如果要从源码进行打包，需要安装 node v18 以上版本，并执行以下命令：

git clone https://github.com/WisdomShell/codeshell-vscode.git
cd codeshell-vscode
npm install
npm exec vsce package

然后会得到一个名为codeshell-vscode-${VERSION_NAME}.vsix的文件。

模型服务

llama_cpp_for_codeshell项目提供CodeShell大模型 4bits量化后的模型，模型名称为CodeShell_q4_0.gguf。以下为部署模型服务步骤：

获取代码

git clone https://github.com/WisdomShell/llama_cpp_for_codeshell.git
cd llama_cpp_for_codeshell
make server

下载模型

在 Hugging Face Hub将模型下载到本地后，将模型放置在以上代码中的 llama_cpp_for_codeshell/models 文件夹的路径，即可从本地加载模型。

git clone https://huggingface.co/WisdomShell/CodeShell-7B-Chat-int4/blob/main/codeshell-chat-q4_0.gguf

部署模型

使用llama_cpp_for_codeshell项目中的server命令即可提供API服务

./server -m ./models/CodeShell_q4_0.gguf --host 127.0.0.1 --port 8080

配置插件

VSCode中执行Install from VSIX...命令，选择codeshell-vscode-${VERSION_NAME}.vsix，完成插件安装。

• 设置CodeShell大模型服务地址
• 配置是否自动触发代码补全建议
• 配置自动触发代码补全建议的时间延迟
• 配置补全的最大tokens数量
• 配置问答的最大tokens数量

功能特性

1. 代码辅助

• 对一段代码进行解释/优化/清理
• 为一段代码生成注释/单元测试
• 检查一段代码是否存在性能/安全性问题

在vscode侧边栏中打开插件问答界面，在编辑器中选中一段代码，在鼠标右键CodeShell菜单中选择对应的功能项，插件将在问答界面中给出相应的答复。

在问答界面的代码块中，可以点击复制按钮复制该代码块，也可点击插入按钮将该代码块内容插入到编辑器光标处。

2. 智能问答

• 支持多轮对话
• 支持会话历史
• 基于历史会话（做为上文）进行多轮对话
• 可编辑问题，重新提问
• 对任一问题，可重新获取回答
• 在回答过程中，可以打断

开源协议

Apache 2.0