Skip to content

README_EN.md

Latest commit

 

History

History
90 lines (59 loc) · 3.79 KB

README_EN.md

File metadata and controls

90 lines (59 loc) · 3.79 KB

CodeShell VSCode Extension

The codeshell-vscode project is an open-source plugin developed based on the CodeShell LLM that supports Visual Studio Code. It serves as an intelligent coding assistant, offering support for various programming languages such as Python, Java, C/C++, JavaScript, Go, and more. This plugin provides features like code completion, code interpretation, code optimization, comment generation, and conversational Q&A to help developers enhance their coding efficiency in an intelligent manner.

Requirements

  • node version v18 and above required
  • Visual Studio Code version 1.68 and above required
  • The CodeShell service is running

Compile the Plugin

If you want to package from source code, you need to install node version 18 or higher and execute the following command:

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

and get codeshell-vscode-${VERSION_NAME}.vsix。

Model Service

The llama_cpp_for_codeshell project provides the 4-bit quantized model service of the CodeShell LLM, named CodeShell_q4_0.gguf. Here are the steps to deploy the model service:

Get the Code

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

Load the model locally

After downloading the model from the Hugging Face Hub to your local machine, placing the model in the llama_cpp_for_codeshell/models folder path in the above code will allow you to load the model locally.

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

Deploy the Model

Use the server command in the llama_cpp_for_codeshell project to provide API services.

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

The default deployment is on local port 8080, and it can be called through the POST method.

Configure the Plugin

  • Set the address for the CodeShell service.
  • Configure whether to enable automatic code completion suggestions.
  • Set the time delay for triggering automatic code completion suggestions.
  • Specify the maximum number of tokens for code completion.
  • Specify the maximum number of tokens for Q&A.

插件配置截图

Features

1. Code Assistance

  • Explain/Optimize/Cleanse a Code Segment
  • Generate Comments/Unit Tests for Code
  • Check Code for Performance/Security Issues

In the VSCode sidebar, open the plugin's Q&A interface. Select a portion of code in the editor, right-click to access the CodeShell menu, and choose the corresponding function. The plugin will provide relevant responses in the Q&A interface.

Within the Q&A interface's code block, you can click the copy button to copy the code block or use the insert button to insert the code block's content at the editor's cursor location.

代码辅助截图

2. Code Q&A

  • Support for Multi-turn Conversations
  • Maintain Conversation History
  • Engage in Multi-turn Dialogues Based on Previous Conversations
  • Edit Questions and Rephrase Inquiries
  • Request Fresh Responses for Any Question
  • Interrupt During the Answering Process

智能问答截图

License

Apache 2.0