https://github.com/cedricguillemet/gpt-toolbox

GPT extension for VSCode
https://github.com/cedricguillemet/gpt-toolbox

Last synced: 12 days ago
JSON representation

GPT extension for VSCode

• Host: GitHub
• URL: https://github.com/cedricguillemet/gpt-toolbox
• Owner: CedricGuillemet
• License: mit
• Created: 2023-01-10T10:02:38.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-16T12:26:23.000Z (almost 2 years ago)
• Last Synced: 2024-08-10T10:03:52.432Z (3 months ago)
• Language: TypeScript
• Size: 335 KB
• Stars: 28
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ChatGPT-repositories - GPT-Toolbox - GPT extension for VSCode (Browser-extensions)

README

        
# GPT-Toolbox

GPT extension for VSCode. 

Generic interface and queries to use with Chat-GPT.

Main feature is documenting selected code.

With more functionalities expected to land in this project.

## Disclaimers:

> :warning: **Code sent and chat API host**: The selected code will be sent to the ChatGPT host. Make sure you are allowed to do so. If your code is private, you may not have the rights to send it to a 3rd Party. 

This extension has been tested mostly on Typescript code. Documentation quality with other languages may vary.

## Running this extension

- Run `npm install` in terminal to install dependencies

- Run the `Run Extension` target in the Debug View. This will:

	- Start a task `npm: watch` to compile the code

	- Run the extension in a new VS Code window

## Settings

Add your own ChatGPT API Key and an optional hint to help ChatGPT generate the comment.

Go to VSCode preferences:

![VSCode preferences](https://github.com/CedricGuillemet/GPT-Toolbox/raw/main/Images/pref.png)

Then fill the API key that you can get from https://beta.openai.com/account/api-keys

![VSCode preferences](https://github.com/CedricGuillemet/GPT-Toolbox/raw/main/Images/settings.png)

You can now also change the host instead of using OpenAI api. In the case you have a private instance of ChatGPT.

## How to use

Select your Typescript code in VScode then right click and select 'GPT Toolbox - Document code'

![VSCode preferences](https://github.com/CedricGuillemet/GPT-Toolbox/raw/main/Images/selectCode.png)

After a few seconds, the documentation comment is there.

![VSCode preferences](https://github.com/CedricGuillemet/GPT-Toolbox/raw/main/Images/resultDoc.png)