diff --git a/yolo.py b/yolo.py index 5adee1d..217d693 100755 --- a/yolo.py +++ b/yolo.py @@ -1,5 +1,16 @@ """ -TODO: Description +AI Chatbot to generate shell commands. + +This script allows the user to ask their question in plain English and translates +that question into a command that can be run in the shell. The functionalities +include leveraging OpenAI's GPT models to generate command, verifying newly generated +commands, checking commands for any unsafe attributes, and allowing the user to +execute or modify the generated command. + +This program is an implementation of an AI model used to assist users in +generating Unix/shell commands or other scripts, based on their natural language +input. The objective is to aid those users who might not remember the exact syntax +of every command or script they frequently use. Sources: — https://github.com/wunderwuzzi23/yolo-ai-cmdbot