Coder Social home page Coder Social logo

vscode-chat's Introduction

VSCode Chat README

VSCode Chat is a VSCode extension that leverages LangChain and OpenAI's GPT API to allow you to ask questions about your files inside of VSCode.



Features

  • Ask natural language questions about your files within the VSCode editor.
  • Get relevant answers about your files instantly, without having to leave the editor.

Usage

First you will need to add your OpenAI API key to the extension settings. You can open your settings by pressing Ctrl + ,. Then, search for "VSCode Chat" and add your API key to the "OpenAI API Key" field.

Now that the setup is complete, you can ask questions about your files by following these steps:

  1. Open the file you want to ask questions about.
  2. Press Ctrl + Shift + P to open the VSCode command palette.
  3. Type VSCode Chat: Ask a question and press enter.
  4. A chat window will appear in the right panel of VSCode.
  5. Type your question in natural language and press enter.
  6. Wait for the extension to generate an answer.
  7. The answer will be displayed in the chat window.

Extension Settings

This extension contributes the following settings:

  • vscode-chat.OPENAI_KEY: OpenAI API Key

Known Issues

  1. It's ugly, I know it, you know it, we all know it. :( I'm working on it.
  2. This is using the paid version of OpenAI's API, so it's not free, i.e., it is bring your own credits.
  3. It's using a Large Language Model, so the responses it generates might be completely wrong, something called "hallucinations".

Release Notes

Here are the release notes for the extension.

0.0.1

Initial release of VSCode Chat with basic functionality. Namely, you can ask questions about your currently open file and get an answer.

Roadmap

Here are some features I plan to add in the future:

  • Add a "Refresh" button to the chat window to refresh the content that you can ask questions about.
  • Add a "Clear" button to the chat window to clear the chat history.
  • Add ability to ask questions about multiple files at once.

vscode-chat's People

Contributors

ncoop57 avatar taisazero avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.