bad-typing-converter-cli v1.0.1

Setup

Prerequisites

• Node.js
• Git (optional)
• a brain
• An OpenAI API Key

Method 1

$ npm i bad-typing-converter-cli

Go to wherever you downloaded this, for example ./node_modules/bad-typing-converter-cli/

$ cp .env.example .env

Open up .env, and paste in your OpenAI API key. Save, and close. You can now use btcc anywhere in your terminal!

Method 2

$ git clone https://github.com/FireStreaker2/Bad-Typing-Converter-CLI.git
$ cd Bad-Typing-Converter-CLI
$ npm i
$ npm i -g
$ btcc ping

If it replies with Pong!, proceed to the next step. If it doesn't, you did something wrong lmao

$ cp .env.example .env

Open and paste your OpenAI API key into the .env file, then save and close. Now, return to your terminal.

$ btcc ping

PLEASE NOTE THAT IF YOU DO NOT RUN npm i -g AFTER THE OTHER STEPS IN METHOD 2 YOU WILL NOT BE ABLE TO USE IT WITH btcc

Commands

You can run btcc or btcc help to display all the current commands, but they'll also be listed below.

btcc - displays help
btcc help - also displays the help message
btcc ping - pings something (idk what it pings) to make sure the cli is working
btcc website - open the website version of this
btcc convert <phrase> - the actual converting part. just do btcc convert + your phrase, and it'll convert after a while. please note that a) you need to have your api key configured, and b) if your phrase is more than one word, you have to surround it in double quotes. (ex. ``btcc convert "hello today i wnt to ues discord")

FAQ

Q: Why did you make this?
A: idk i wanted to make a cli for some reason

Q: whats the purpose of this?
A: so you can quickly translate your friends badly typed sentence i guess

Q: Will this be maintained?
A: probably not lmao

Q: This doesn't work for me, what should I do?
A: make sure you followed the steps, if it still doesnt work you can open an issue and ill help you from there

Q: You suck at coding
A: i know

Contributing

If you would like to contribute, you can fork the repo and make a PR, or contact me via email @ suggestions@firestreaker2.gq

Credits

OpenAI API
Commander
NPM

License

MIT