Git Product home page Git Product logo

nanospeck / aldy-code-explainer Goto Github PK

View Code? Open in Web Editor NEW

This project forked from eimenhmdt/explain-code-vs-extension

0.0 0.0 0.0 67 KB

This minimalistic VS Code extension allows you to use the power of OpenAI's GPT-3 to explain and understand code. By providing your OpenAI API key, you can use the extension to explain code snippets and receive clear and concise explanations in natural language without having to leave your IDE.

License: MIT License

JavaScript 100.00%

aldy-code-explainer's Introduction

Explain Code VS Extension README

The minimalistic 'Explain Code' extension for Visual Studio Code allows developers to easily understand and explain complex code. Using the OpenAI GPT-3 language model, the extension generates natural language explanations for code snippets and entire files that can be accessed without having to leave the IDE.

Made with โ˜• by Eimen

Features

  • Generates natural language explanations for code snippets and entire files.
  • Utilizes the OpenAI GPT-3 language model for accurate and human-like explanations.
  • Easy to use:
    • Explain code snippets: highlight code, right click, click "Explain selected code"
    • Explain whole file: Click on the "Explain Code" button in the bottom right of your IDE

Requirements

A valid OpenAI API key, which can be obtained from the OpenAI website

Extension Settings

The Explain Code extension contributes the following setting:

  • openaiKey: Your OpenAI API key, which is used to access the GPT-3 language model.

Known Issues

  • If the OpenAI API key is not set, the extension will not work.
  • The function to explain whole files only works for small files, as the OpenAI API has a limit of 4000 tokens (approx. 3000 words) per request.

Release Notes

1.0.0

Initial release of the Explain Code Extension

Contributing

If you are interested in contributing to the development of this extension, please check out the GitHub repository

License

This extension is licensed under the MIT License.

Enjoy!

aldy-code-explainer's People

Contributors

eimenhmdt 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.