A JetBrains extension that allows you to use ChatGPT inside your favourite IDE
[![Downloads][downloads-shield]][plugin-repo]
[![Rating][Rating-shield]][plugin-repo]
[![Version][version-shield]][plugin-repo]
[![Contributions not available][contributions-not-available-svg]][contributions-not-available]
Table of Contents
## About The Project
This is an extension for JetBrains IDEs that integrates ChatGPT into your coding environment.
By leveraging the power of GPT-3, this makes it an invaluable tool for developers looking to streamline their workflow and gain a deeper understanding of the code they're working on.
## Getting Started
To get started, follow these simple steps:
### Prerequisites
In order to use the extension, you need to have a JetBrains IDE installed and the API key configured.
You can find the API key in your [User settings][api-key-url].
### Installation
The plugin is available from [JetBrains Marketplace][plugin-repo].
You can install it directly from your IDE via the `File | Settings/Preferences | Plugins` screen.
On the `Marketplace` tab simply search for `codegpt` and select the `CodeGPT` suggestion:
![marketplace][marketplace-img]
### API Key Configuration
After the plugin has been successfully installed, the API key needs to be configured.
You can configure the key by going to the plugin's settings via the `File | Settings/Preferences | Tools | CodeGPT`.
On the settings panel simply click on the `API key` field, paste the key obtained from the OpenAI website and click `Apply/OK`:
![plugin-settings][plugin-settings]
#### Azure OpenAI configuration
Specifically for Azure OpenAI services, you will have to input three supplementary fields:
* the `Resource Name`, which is the name of your Azure OpenAI Cognitive Services. It's the first part of the url you're provided to use the service: `https://my-resource-name.openai.azure.com/` -> use `my-resource-name`. You can find it in your Azure Cognitive Services page, under `Resource Management` -> `Resource Management` -> `Keys and Endpoints`.
* the `Deployment ID`, which is the name of your Deployment. You can find it in the Azure AI Studio, under `Management` -> `Deployment` -> `Deployment Name` column in the table.
* the `API Version`, I usually used the last non-preview version, which is currently `2023-05-15`.
In addition to these, you need to input one of the two API Keys provided, found along with the `Resource Name`.
## Features
The plugin provides several key features, such as:
### Ask Anything
Ask anything you'd like.
### Select and Ask
Ask anything related to your selected code.
### Replace Generated Code
Instantly replace a selected code block in the editor with suggested code generated by AI.
### Regenerate Response
Expected a different answer? Re-generate any response of your choosing.
