Skip to main content

Installation & Login

info

Currently, Codesouler has been listed on the Jetbrain and VSCode plugin stores. Users can install it through the IDE plugin store.

1.Installation​

(1) VSCode​

Download​

🔗 https://marketplace.visualstudio.com/items?itemName=OpenCSG.codesouler

Steps

Please follow these steps to install CodeSouler:

  1. Open the VSCode IDE on your computer.

  2. Open the Extension Marketplace by clicking the extension icon in the sidebar or by using shortcut ⌘Cmd + Shift + X (macOS) | Ctrl + Shift + X (Windows/Linux).

  3. Enter "CodeSouler" in the text box, find the corresponding plugin and click Install.

  4. After the installation is complete, you can invoke CodeSouler by using shortcut ⌘Cmd + L (macOS) | Ctrl + L (Windows/Linux). You may need to restart VsCode to load it after the initial installation.

  5. Now the CodeSouler icon will be displayed in the sidebar, and you can click on the icon to evoke it at any time.

(2) JetBrain​

Download​

🔗 https://plugins.jetbrains.com/plugin/24737-codesouler

Steps

Please follow these steps to install CodeSouler:

  1. Open JetBrains Editor on your computer.

  2. Open Settings： ⌘Cmd +, (macOS) | Ctrl + Alt + S(Windows/Linux).

  3. Enter CodeSouler in the text box, find the corresponding plugin and click Install.

  4. After the installation is complete, you can call up CodeSouler by using shortcut ⌘Cmd + J (macOS) | Ctrl + J (Windows/Linux). You may need to restart JetBrains after the initial installation to load it.

  5. Now the CodeSouler icon will be displayed in the sidebar, and you can click on the icon to evoke it at any time.

2.Login​

After the initial installation is completed, you need to fill in the API Key to log in. Please follow these steps to obtain the API Key.

  1. Visit the OpenCSG website: https://opencsg.com/

  2. Click the icon in the upper right corner to log in/register.

  3. After successful login, enter the access-token page: https://opencsg.com/settings/starship-access-token

  4. Click "New API Key" and enter the API Key Name (you can name it yourself).

  5. After creating, the system will generate the corresponding API Key. Click Copy.

  6. Return to the plugin page, paste the obtained API Key, and you can log in successfully.