CodeExplainer

Usage

Three ways to use this Command Line application.

A. By Directly Executing npm package

1. Create .env file out of example.env and paste your OpenAi secret key.
2. Run Command `npx codeexplainer <FileName>` to execute package without installing it.

B. By installing globally or locally

To install globally Run Command

1. Run Command `npm i -g codeexplainer` to install package globally
2. Create .env file out of example.env and paste your OpenAi secret key
3. Run command `codeexplainer <FileName>`

To install Locally Run Command

1. Run Command `npm i codeexplainer --save-dev` to install package locally as dev dependency.
2. Create .env file out of example.env and paste your OpenAi secret key
3. Run command `codeexplainer <FileName>`

C. By cloning git repos

1. Run command git clone https://github.com/anurag-ay/CodeExplainer to clone github repo.
2. Navigate to cloned dir
3. Run command npm i -g to install the package globally
4. Create .env file out of example.env and paste your OpenAi secret key
5. Run command codeexplainer <FileName> to get explanation

License

ISC © termTranslate