CLI App for Code Review from any local file.

---

Table of Contents

• Introduction
• Prerequisites
• Installation
• Configuration-Usage
• Additional Features
• Demo
• Contributing
• License

---

Introduction

Welcome to the CLI App for Code Review! This Node.js application allows developers to quickly and easily get explanations and correction for code snippets using the OpenAI API.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (version 14 or higher)
• npm (Node.js package manager)
• OpenAI API Key

Installation

Follow these steps to install the CLI App:

1. Clone the repository:

   git clone https://github.com/dibyansh01/CodeFile-review-CLI-APP.git
   

2. Navigate to the project directory:

   cd CodeFile-review-CLI-APP
   

3. Install dependencies:

   npm install
   

Configuration-Usage

1. Before running the app, ensure you set up your OpenAI API key. Create a .env file in the project root and add your key:

   OPENAI_API_KEY=your-api-key-goes-here

2. Build process:

   tsc

3. Make the Script Executable:

   chmod +x src/index.js
   

4. Now install the package globally using:

   sudo npm install -g
   

5. Usage: After finishing all above prerequisites, you can use the command like this:

   code-review-cli explain path/to/your/code/file.js
   

Replace the above with the path to the file you want to explain. The app will read the code from specified file, send it to the OpenAI API for analysis, and provide an English explanation in the terminal

Additional Features

Apart from code explanation, this CLI App can be extended to assist developers in various ways. For example:

1. Code Correction: Users will get corrected code if any bugs are detected in the given code.
2. Interactive Learning: Use the OpenAI API to create an interactive learning environment where developers can ask questions about specific code segments.

Demo

Screencast.from.12-30-2023.08.00.13.PM.webm

Contributing

Thank you for considering contributing to CodeFile-review-CLI-APP! I welcome contributions from the community to make this project even better. Here's how you can get involved:

• Reporting Issues: If you find a bug or have a suggestion for an improvement, please open an issue on this repository. Provide as much detail as possible to help us understand and address the problem.

• Pull Requests: We welcome code contributions! If you want to add a new feature, fix a bug, or improve the project in any way, feel free to fork this repository, make your changes, and submit a pull request.

• Feature Requests: If you have an idea for a new feature or enhancement, you can open a feature request on this repository. We'd love to hear your ideas!

• Documentation: If you find any issues with the documentation, or if you want to improve it, please submit a pull request with your changes.

Let's create a positive and inclusive environment for all users and contributors.

License

This project is licensed under the MIT License - see the LICENSE file for details.