🪄StarShip CodeSouler——Your AI Coding Mate
StarShip CodeSouler is a programming plugin powered by the latest large model technology, introduced by OpenCSG. From generating tests to writing and reviewing code, CodeSouler offers a suite of tools to enhance efficiency, improve code quality, and streamline the development process, aimed at optimizing your software development lifecycle
✨Quick Access
💫Why CodeSouler
-
Intelligent Code Commenting: CodeSouler automatically analyzes code logic and adds accurate, detailed comments. Whether it's variable naming, function descriptions, or complex logical judgments, the plugin accurately captures and generates easy-to-understand comment content, helping developers and team members quickly grasp code intentions and reduce communication costs.
-
Predictive Code Completion: CodeSouler analyzes your code's context in real-time to predict what you'll write next, offering suggestions as inline ghost text. It can complete anything from a single variable to an entire function or class. Simply press the Tab key to accept the suggestion, significantly boosting your coding speed, reducing repetitive work, and helping you avoid common errors.
-
Code Optimization and Refactoring:CodeSouler automatically identifies and suggests optimization points in code, such as removing redundant code, optimizing variable naming, simplifying loops, etc. It also provides instant repair suggestions and refactoring solutions for common code errors and performance bottlenecks, helping developers effortlessly improve code quality and runtime efficiency.
-
Test Case Generation：CodeSouler can automatically generate comprehensive test suites tailored to your codebase, covering major paths and boundary cases to ensure that your code remains stable and reliable during modifications and expansions.
-
Project Code Interaction Q&A:CodeSouler can analyze real-time user questions based on any project code or file content, and provide accurate answers and suggestions based on project and file content. Whether it is questions about code logic, function function, or project architecture, CodeSouler can provide timely and professional answers to help developers quickly solve problems and improve development efficiency.
🗝️Getting started
CodeSouler allows you to manipulate code in various ways, supporting the following methods:
1.Right-Click on Code Blocks
- Select the target code block you wish to operate on.
- Right-click and choose CodeSouler to add comments, optimize, refactor, etc. to the target codebase.
Follows are the functions of each menu:
| Name | Description |
|---|---|
| Edit Code | Editing code in chat box |
| Fix Grammar / Spelling | Fix grammar and spelling errors |
| Fix this code | Fix selected code |
| Optimize this code | Optimize selected code |
| Write a docstring for this code | Write a feature description for the selected code |
| Write comments for this code | Add comments to the selected code |
2. Edit Code
Selected the code, click the "Edit Code" menu or use Shortcut key Ctrl + L. Input the requirements in the pop-up window, you can quickly modify the selected code segment.
3.CodeSouler Conversation Box:
** (1) Invoke the Conversation Box ** VSCode
- Use Ctrl + L / Command + L to bring up the conversation window.
- With a code block selected, use Ctrl + L / Command + L to quickly add the code JetBrain
- Use Ctrl + J / Command + J to bring up the conversation window.
- With a code block selected, use Ctrl + J / Command + J to quickly add the code segment context to the conversation box.
(2)Insert code block
- Click 'Apply' button, CodeSouler will help to insert the code to cursor position in current file, and show the diff.
(3) Operation Commands
- CodeSouler implements a complete set of operation commands. After invoking the conversation box, users can combine commands to quickly send requests.
- There are three main operators:
- "@"：use agents
- "+"：use objects
- "/"：specific operations
The complete operation methods and function descriptions are outlined in the following table:
| Method | Name | Description |
|---|---|---|
| Operation "/" | edit | Edit selected code |
| test | Generate unit tests for the selected code | |
| codereview | Conduct code review | |
| secscan | Perform a security scan of the code | |
| Reference object "+" | Files | Reference files |
| Code | Reference code snippets | |
| Docs | Reference document | |
| Git Diff | Code modification differences | |
| Terminal | Quoting terminal content | |
| Problems | Reference the issues in the current file | |
| Folder | Reference folder | |
| Codebase | Automatically identify and reference relevant code, preferentially retrieve the most recently opened files | |
| GitLab Issues | Automatically get the issue of current Gitlab user | |
| GitLab Users | Reference current Gitlab User | |
| GitLab Merge Requests | Reference the Merge Request of current Gitlab user | |
| Local Docs | Reference the documents of path .codesouler/docs | |
| MCP Servers | Reference the MCP of current user |
(4) Task Execution and Control
When CodeSouler's suggestions involve executing terminal commands (e.g., installing dependencies or running scripts), it directly utilizes VSCode's integrated terminal to perform the task. At this point, an interactive control panel will appear in your interface, providing the following options:
| Action | Description |
|---|---|
| Run | Executes the current command or applies the code modification suggested by CodeSouler. Click this button to proceed after you have reviewed and confirmed that the proposed step is correct. |
| Skip | Discards the current suggestion and moves on to the next task. Use this if you believe the current suggestion is incorrect or unnecessary. |
| Auto-Approve | Automatically approves and executes all subsequent steps for the current task. Once enabled, CodeSouler will perform all actions sequentially without requiring manual confirmation for each step. Use with caution. |
| Proceed While Running | Executes long-running commands in the background, allowing you to continue with other work. This is ideal for time-consuming tasks like compiling or installing large dependencies, as it prevents the UI from being blocked. |
| Kill Command | Forcibly stops the command currently running in the background. If a background command gets stuck, encounters an error, or is no longer needed, click this button to terminate the process immediately. |
4. Switch Language
CodeSouler supports both Chinese and English. Click the "Settings" button, and switch the language in the settings page.
