Welcome to CodeSouler!

User Guide: https://opencsg.com/docs/StarShip/CodeSouler/CodeSouler_intro

StarShip CodeSouler is a IDE plugin powered by the latest advancements in large model technology, developed by OpenCSG. Whether you’re generating tests, writing code, or conducting reviews, CodeSouler provides a comprehensive suite of tools designed to boost efficiency, enhance code quality, and streamline your development process. Ultimately optimizing your entire software development lifecycle.

Capabilities

1.Code Comments

CodeSouler intelligently analyzes the logic of your code and adds precise, detailed comments. Whether it’s variable naming, function purposes, or complex logical conditions, the plugin accurately captures these elements and generates clear, understandable comments.

2.Code Optimization

CodeSouler automatically identifies opportunities for optimization within your code, such as removing redundancies, improving variable naming, and simplifying loops. It also provides instant fixes and refactoring recommendations for common coding errors.

3.UnitTests Generation

CodeSouler generates comprehensive unit test suites specifically for your codebase.

4. Code Q&A

You can ask any questions about project and files. CodeSouler will deliver accurate answers and recommendations based on the context.

Getting started

CodeSouler offers various methods to assist you. Let's start with following methods:

1. Right-Click on Highlight Code Block:

Highlight the target code block, right-click, and select CodeSouler. Then you can adding comments, refactoring etc.

2. CodeSouler Command Window:

Use Ctrl + L (Windows/Linux) or Command + L (MacOS) to open the command window. Also the highlight code block will be automaticaly added to command window.

3. Command Operators

CodeSouler provides a comprehensive set of commands. Once the command window is open, you can easily send requests by commands.

Two operators are frequently used: The / operator defines the action to be performed, while the @ operator indicates the object that the action targets.