Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 3.92 KB

README.md

File metadata and controls

45 lines (29 loc) · 3.92 KB

Wagwan CLI

A CLI tool that explains code snippets, converts them to other languages, and fixes bugs, built in Python using OpenAI's Codex.

Installation

You can install wagwan by running the following command in your terminal.

pip install "git+https://github.com/DaveOkpare/wagwan-cli"

Usage

wagwan uses OpenAI's Codex API. To use it, you'll first need to request access from OpenAI. Once granted access, obtain an API key from your dashboard, and run the following command.

wagwan login

Once you have configured your environment, run wagwan --help to find the various options available.

wagwan --help


 Usage: wagwan [OPTIONS] COMMAND [ARGS]...                                                                                                              
                                                                                                                                                        
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                                                              │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                       │
│ --help                        Show this message and exit.                                                                                            │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ convert                Converts script from one language to another.                                                                                 │
│ explain                Explains a Python script.                                                                                                     │
│ login                  Initializes OpenAI                                                                                                            │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

License

This project is open-sourced under the MIT license. See the License file for more information.