Skip to content

A Visual Studio Code extension to support ChatGPT. The extension is pair-programmed with ChatGPT.

License

Notifications You must be signed in to change notification settings

analogpvt/vscode-gpt

Repository files navigation


Ask ChatGPT

ChatGPT conversations in Visual Studio Code

Badge for version for Visual Studio Code extension gencay.vscode-chatgpt

📢 December 25 Update - Chromium-based browser solution

The extension is expected to work without any 403s or 429s since it will now use the browser behind the scenes to make the chatGPT requests. Please make sure that autologin setting is set to true (default is true) and you keep the browser open all the time after logging in. It'll be automatically minimized after successful login. You can then ask questions to ChatGPT via the extension as usual.

ChatGPT as your copilot to level up your developer experience

  • 🤖 Zero-Config setup. Simply login to OpenAI as usual.
  • ➡️ Export all your conversation history at once in Markdown format.
  • 🔃 Option to clear and restart the conversation with ChatGPT.
  • 🍻 Optimized for dialogue! Have a conversation with ChatGPT with follow-ups.
  • 💯 Get help from ChatGPT within vs-code for implementing test cases, explaining it or finding bugs.
  • 📝 Create projects/files with one click using built-in actions in the conversation view.
  • ⚡ Built-in syntax highlighting for ChatGPT suggested code using the default code-font of your Visual Studio Code!
  • 🖼️ Icon is generated by dall-e-2.

Setup

  1. Click on extension icon on your sidebar and hit Login button.

  2. A new browser window (Default is Chrome but you may override it with any Chromium-based browser) will open up redirected to https://chat.openai.com/. Wait till you see login page, and click on Login on your browser.

  3. Solve captchas if you are prompted and continue.

  4. After successfully logging in, the browser will be minimized.

ℹ️ You will need to have a browser open and be logged in at all times. If you close the browser or your VS-Code instance, you will be asked to login again in your next session.

📝 You can auto-fill the email address and/or password during logins. Update the extension settings with those information for quicker login.

🤖 Below is a sample autologin flow. Simply login & keep your browser minimized for dialogues with ChatGPT:


Override settings with any Chromium-based browser

  1. To use Edge, go to this URL:edge://version and copy the executable path

    • image
  2. Override the chromium path by going to vs-code settings and search for chatgpt:chromiumPath. Paste the executable path to the textbox as shown in the below screenshot

    • image
  3. [Maybe required] Restart your vs-code to make sure the change is propagated. This is required only if you have previously authenticated using a different browser.

🚀🎉 Zero Configuration (Automated Authentication)

  • Zero-Config Autologin lets the extension grab the required tokens automatically using puppeteer. The extension will use the browser behind the scenes, so you are not expected to receive 4xx errors while asking ChatGPT via extension unless there is OpenAI outages.

  • 2 options to run ChatGPT assistant in your vs-code:

    1. [Recommended] Autologin - Uses browser to ask questions to ChatGPT.
    2. Manually login on a browser and grab required tokens. Described in Manual Setup. This option has problems due to using unofficial OpenAI API usage and rate-limiting.

Features

The extension comes with context menu commands, copy/move suggested code into editor with one-click, conversation window and customization options for OpenAI's ChatGPT prompts.

ChatGPT conversation window in vs-code

🆕 Export all your conversation history withs one click


🍻 Optimized for dialogue


Edit and resend a previous prompt


Copy or insert the code ChatGPT is suggesting right into your editor.


Ask free-form text questions that will be listed in the conversation window. The conversation is kept in cache until vs-code instance is closed.

Use defaults or customize your code prompts

  • ChatGPT: Add tests: Write tests for you. Right click on a selected block of code, run command.
    • "default": "Implement tests for the following code",
    • "description": "The prompt prefix used for adding tests for the selected code"
  • ChatGPT: Find bugs: Analyze and find bugs in your code. Right click on a selected block of code, run command.
    • "default": "Find problems with the following code",
    • "description": "The prompt prefix used for finding problems for the selected code"
  • ChatGPT: Optimize: Add suggestions to your code to improve. Right click on a selected block of code, run command.
    • "default": "Optimize the following code",
    • "description": "The prompt prefix used for optimizing the selected code"
  • ChatGPT: Explain: Explain the selected code. Right click on a selected block of code, run command.
    • "default": "Explain the following code",
    • "description": "The prompt prefix used for explaining the selected code"
  • ChatGPT: Add comments: Add comments for the selected code. Right click on a selected block of code, run command.
    • "default": "Add comments for the following code",
    • "description": "The prompt prefix used for adding comments for the selected code"

Other available commands

  • ChatGPT: Ask anything: Free-form text questions within conversation window.
  • ChatGPT: Clear session: Clears the current session. Useful in case of API errors in manual mode only.
  • ChatGPT: Clear conversation: Clears the conversation window and resets the thread to start a new conversation with ChatGPT.
  • ChatGPT: Export conversation: Exports the whole conversation in Markdown for you to easily store and find the Q&A list.

Customization settings

  • Opt-in to use automation to authenticate OpenAI.
  • You can configure the commands to use any prompts for the selected code!
  • Opt-in to receive notification when ChatGPT sends you a message!

Manual Setup

ℹ️ This method is no longer recommended since hard rate-limiting by OpenAI services. Please use the AutoLogin option with Zero-Configuration required.

  1. Go to https://chat.openai.com and login.
  2. Open your browser's developer tools
    • Hit F12 to open the developer tools in most browsers
    • Alternatively, right click on the browser window and select Inspect
  3. Go to Application -> Cookies -> https://chat.openai.com. You will need the following cookies:
    • __Secure-next-auth.session-token: The extension will use this to send prompts to ChatGPT
    • cf_clearance: CloudFlare clearance token. A security measure OpenAI put in place to block automated access.
  4. Go to Console and type in the following code to get your user-agent
    • navigator.userAgent: This is your browser's user-agent, needed for CloudFlare clearance. Enter the value of userAgent when prompted by the extension. Copy its value without single or double quotes.
  5. Now that you have all required session variables, run any command using the extension and you'll be asked to enter these values:
    • __Secure-next-auth.session-token: An encoded token starting with ey***
    • cf_clearance: An alpha-numeric token
    • userAgent

Troubleshooting

  • It's possible that openai systems may experience issues responding to your queries due to high-traffic from time to time.
  • If you get ChatGPTAPI error 429, it means that you are making Too Many Requests. Please wait and try again in a few moments. If it persists, restart your vs-code.
  • If you see ChatGPTAPI error terminated, your requests are being throttled. Please try again later.
  • If you encounter persistent issues with your queries, try restarting your VS-Code and retry logging in.

Credits

About

A Visual Studio Code extension to support ChatGPT. The extension is pair-programmed with ChatGPT.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 47.7%
  • TypeScript 41.5%
  • CSS 10.8%