diff --git a/README.md b/README.md index 17033f6..a982361 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ # Install (Linux instructions) ``` +git clone https://github.com/wunderwuzzi23/yolo-ai-cmdbot +cd yolo-ai-cmdbot pip install -r requirements.txt chmod +x yolo.py alias yolo=$(pwd)/yolo.py ``` -# Use +## OpenAI API Key configuration -Here are a couple of examples. By default the command that comes back from GPT-3 will be immediatly executed (yolo!). If you want to inspect the command before running add the `-a` argument, e.g `yolo -a delete the file test.txt`. +There are two ways to configure the key: +- You can either `export OPENAI_API_KEY=` +- Create a file at `~/.openai.apikey` with the key in it + +# Using yolo + +Here are a couple of examples. By default the command that comes back from GPT-3 will be immediatly executed (yolo!). +If you want to inspect the command before running add the `-a` argument, e.g `yolo -a delete the file test.txt`. More examples: ``` yolo whats the time? -yolo whats the time in UTC? -yolo is there a ssh-agent process running +yolo whats the time in UTC +yolo is there an ssh-agent process running yolo create a file named test.txt and write my user name into it yolo print the contents of the test.txt file yolo -a delete the test.txt file @@ -23,4 +32,4 @@ yolo -a delete the test.txt file # License -MIT. No Liability. No Warranty. But lot's of fun. \ No newline at end of file +MIT. No Liability. No Warranty. But lot's of fun.