Merge pull request #9 from KAuser2094/main

Better `install.bat` file

README.md

@@ -33,10 +33,16 @@ That's it. Now make sure you have an OpenAI API key set.
 
 ## Installation script (Windows)
 
-For windows you can run `.\install.bat` (or double-click) after cloning the repo. It will do the following:
+For windows you can run `.\install.bat` (or double-click) after cloning the repo. By default it does the following:
-1. Copies the necessary files to `~/yolo-ai-cmdbot/`
+1. Copies the necessary files to `~\yolo-ai-cmdbot\`
 2. Creates a `yolo.bat` file in `~` that lets you run equivalent to `python.exe ~\yolo-ai-cmdbot\yolo.py`
 
+You will also have the option to:
+1. Change the location where `yolo-ai-cmdbot\` and `yolo.bat` will be created
+2. Skip creating `yolo-ai-cmdbot\` and use the folder of the cloned repository instead.
+3. Create a `.openai.apikey` and/or `.yolo-safety-off` file in your `~` directory
+
+That's it. Now make sure you have an OpenAI API key set.
 
 # macOS 
 
@@ -52,7 +58,9 @@ If you use `install.bat` you should have a `yolo.bat` file in your `~` directory
 
 `.\yolo.bat what is my username`
 
-you can put the `yolo.bat` file into a $PATH directory (like `C:\Windows\System32`) to use in any directory
+You can put the `yolo.bat` file into a $PATH directory (like `C:\Windows\System32`) to use in any directory like so:
+
+`yolo what is my username`
 
 Have fun.
 
@@ -62,6 +70,13 @@ There are two ways to configure the key:
 - You can either `export OPENAI_API_KEY=<yourkey>`, or have a `.env` file in the same directory as `yolo.py` with `OPENAI_API_KEY="<yourkey>"` as a line
 - Create a file at `~/.openai.apikey` with the key in it
 
+## Windows
+
+On windows `export OPENAI_API_KEY=<yourkey>` will not work instead:
+- Run `$env:OPENAI_API_KEY="<yourkey>"` to set key for that terminal
+- Or, Run PowerShell as administrator and run `setx OPENAI_API_KEY "<yourkey>"`
+- Or, Go to `Start` and search `edit environment variables for your account` and manually create the variable with name `OPENAI_API_KEY` and value `<yourkey>`
+
 # Using yolo
 
 By default `yolo` will prompt the user before executing commands.

install.bat

@@ -1,25 +1,341 @@
 @echo off
-:: Installs yolo in the user's home directory
+setlocal enabledelayedexpansion
 
-set TARGET_DIR= %HOME%yolo-ai-cmdbot
+:: First check if `install.bat` (this) has needed files in same directory
-set TARGET_FULLPATH= %TARGET_DIR%\yolo.py
+if not exist %~dp0\yolo.py ( echo `yolo.py` missing in %~dp0 cannot install & goto :choice_default_3 )
+if not exist %~dp0\prompt.txt ( echo `prompt.txt` missing in %~dp0 cannot install & goto :choice_default_3 ) 
 
-mkdir %TARGET_DIR%
+:: Note: "~" or %HOME% is equivalent to "%HOMEDRIVE%%HOMEPATH%\" but the latter is set in VM environments (from what I can tell)
-copy yolo.py %TARGET_DIR%
+:: INSTALL_DIR = Directory the "yolo-ai-cmdbot\" will go to.
-copy prompt.txt %TARGET_DIR%
+:: SCRIPT_DIR = Directory the "yolo.bat" script will go to.
+:: createDIR = Whether or not a seperate "yolo-ai-cmdbot\" directory will be made/used to hold "yolo.py" and "prompt.txt". 1=Yes, 2=Just_use_Repo (the folder this is in)
+:: createAPIKEY = Whether to create a ".openai.apikey" at %HOMEDRIVE%%HOMEPATH%\. 1=Yes, 2=No
+:: createSafetyOff = Whether to create a ".yolo-safety-off" at %HOMEDRIVE%%HOMEPATH%\. 1=Yes, 2=No
 
-:: Windows: Creates a yolo.bat file into %HOME% directory which will let you run similar to Linux/MacOS
+:: Default values:
-:: Example: Input: ".\yolo.bat print hello" to "yolo print hello"
+set "INSTALL_DIR=%HOMEDRIVE%%HOMEPATH%\"
+set "SCRIPT_DIR=%HOMEDRIVE%%HOMEPATH%\"
+set /a "createDIR=1"
+set /a "createAPIKEY=2"
+set /a "createSafetyOff=2"
+set "installing=1"
 
-:: yolo.bat can only be used in same directory; or, any directory if put in a $PATH directory (type $env:PATH in PowerShell and pick an appropriate path to paste in)
+:: Set Variables To User Defined If Needed 
-:: C:\Windows\System32 is the $PATH directory everyone is likely to have
+:: (This was as painful to make as it looks)
+cls
+call :print_default
+choice /n /c YNCO /m "Let me know which option you want to select: "
+set installing=%ERRORLEVEL%
+goto :choice_default_!ERRORLEVEL!
 
-:: Create yolo.bat and if it isn't already there input its code.
+:choice_default_2
-find "@echo off" "%HOME%\yolo.bat" && (
+cls
-    echo "yolo.bat" Already Exists
+call :print_use_directory
-) || (
+choice /n /c YN /m "Let me know which option you want to select: "
-    copy /y nul %HOME% yolo.bat
+set /a createDIR=%ERRORLEVEL%
-    echo @echo off>>"%HOME%yolo.bat"
+goto :choice_use_directory_!ERRORLEVEL!
-    echo python.exe %HOME%yolo-ai-cmdbot\yolo.py %%*>>"%HOME%\yolo.bat"
+
-    echo Created "yolo.bat" in %HOME%
+:choice_use_directory_1
-)
+cls
+call :print_install
+choice /n /c NY /m "Let me know which option you want to select: "
+goto :choice_install_!ERRORLEVEL!
+
+:choice_install_1
+set /p INSTALL_DIR="Enter a path for `yolo-ai-cmdbot\` to be made:"
+if exist !INSTALL_DIR!\ ( goto :choice_use_directory_1 ) else ( echo This file path does not exist & goto :choice_install_1 )
+
+:choice_install_2
+:choice_use_directory_2
+cls
+call :print_script
+choice /n /c NY /m "Let me know which option you want to select: "
+goto :choice_script_!ERRORLEVEL!
+
+:choice_script_1
+set /p SCRIPT_DIR="Enter a path for `yolo.bat` to be made:"
+if exist !SCRIPT_DIR!\ ( goto :choice_use_directory_2 ) else ( echo This file path does not exist & goto :choice_script_1 )
+
+:choice_script_2
+:choice_default_1
+set "TARGET_DIR=!INSTALL_DIR!\yolo-ai-cmdbot\"
+set "TARGET_FULLPATH=!TARGET_DIR!\yolo.py"
+
+::Actually Install Yolo
+cls
+if /i %createDIR%==1 ( call :install_yolo_directory )
+if /i %createDIR%==2 ( call :install_yolo_repository )
+
+::Make sure safety is on when default installing 
+if /i !installing!==1 ( del %HOMEDRIVE%%HOMEPATH%\.yolo-safety-off )
+
+:choice_default_4
+::Optional files (Only runs in non-Default install or Optional File Install):
+if /i !installing!==2 ( call :install_optional )
+if /i !installing!==4 ( call :install_optional )
+
+::Show a guide
+cls
+if /i !installing!==1 ( call :print_guide )
+if /i !installing!==2 ( call :print_guide )
+
+
+:: End Point
+:choice_default_3
+pause
+:: In Case of Errors in Choice
+:choice_default_0
+:choice_default_9009
+:choice_install_0
+:choice_install_9009
+:choice_script_0
+:choice_script_9009
+:choice_use_directory_0
+:choice_use_directory_9009
+color
+goto :EOF
+
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+::                                              Functions                                                             ::
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+::                                             Installation                                                           ::
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+:: Installs yolo using created directory
+:install_yolo_directory
+echo Installing Yolo (Using Created Directory)
+call :create_yolo_directory
+call :create_yolo_bat_from_directory
+call :create_env_in_directory
+goto :EOF
+
+:: Installs yolo using cloned repositiory
+:install_yolo_repository
+echo Installing Yolo (Using Cloned Repository)
+call :create_yolo_bat_from_repository
+call :create_env_in_repository
+goto :EOF
+
+:: Installs optional files if user wants
+:install_optional
+cls
+call :print_apikey
+choice /n /c YN /m "Let me know which option you want to select: "
+set /a createAPIKEY=!ERRORLEVEL!
+cls
+call :print_safetyoff
+choice /n /c YN /m "Let me know which option you want to select: "
+set /a createSafetyOff=!ERRORLEVEL!
+
+if /i !createAPIKEY!==1 ( call :create_openai_apikey )
+if /i !createSafetyOff!==1 ( call :create_safety_off )
+goto :EOF
+
+:: Creates a directory to hold yolo.py and prompt.txt
+:create_yolo_directory
+echo Yolo Directory:
+echo Installing to !TARGET_DIR!
+mkdir !TARGET_DIR!
+copy  %~dp0\yolo.py !TARGET_DIR!
+copy  %~dp0\prompt.txt !TARGET_DIR!
+goto :EOF
+
+:: Create yolo.bat and input code linking to created directory
+:create_yolo_bat_from_directory
+echo Yolo Batch (Directory):
+echo `yolo.py` should be in `!TARGET_DIR!`...
+if not exist !TARGET_FULLPATH! ( echo Not Found: Aborting "create_yolo_bat_from_directory" ) else (
+    echo Found: Creating `yolo.bat` in `!SCRIPT_DIR!`
+    copy nul !SCRIPT_DIR!\yolo.bat
+    echo @echo off>!SCRIPT_DIR!\"yolo.bat"
+    echo python.exe !TARGET_DIR!\yolo.py %%*>>!SCRIPT_DIR!\"yolo.bat"
+)
+goto :EOF
+
+:: Create yolo.bat and input code linking to repository
+:create_yolo_bat_from_repository
+echo Yolo Batch (Repository):
+echo `yolo.py` should be in `%~dp0`...
+if not exist %~dp0\yolo.py ( echo Not Found: Aborting "create_yolo_bat_from_repository") else (
+    echo Found: Creating `yolo.bat` in `!SCRIPT_DIR!`
+    copy nul !SCRIPT_DIR!\yolo.bat
+    echo @echo off>!SCRIPT_DIR!\"yolo.bat"
+    echo python.exe %~dp0\yolo.py %%*>>!SCRIPT_DIR!\"yolo.bat"
+)
+goto :EOF
+
+:: Creates the safety off file and puts it in ~ for you
+:create_safety_off
+echo Yolo Safety Off:
+echo Creating `.yolo-safety-off` in `%HOMEDRIVE%%HOMEPATH%\`
+copy nul %HOMEDRIVE%%HOMEPATH%\.yolo-safety-off
+goto :EOF
+
+:: Creates the .openai.apikey if it doesn't already exists (otherwise, does nothing)
+:create_openai_apikey
+echo Yolo OpenAi ApiKey:
+echo Creating `.open.apikey` (if not already exists) in `%HOMEDRIVE%%HOMEPATH%\`
+copy nul %~dp0\.openai.apikey
+robocopy %~dp0 %HOMEDRIVE%%HOMEPATH%\ .openai.apikey /xc /xn /xo /nfl /ndl /njh /njs /nc /ns /np
+del %~dp0\.openai.apikey
+goto :EOF
+
+:: Creates the .env if it doesn't already exists in chosen install directory (otherwise, does nothing)
+:create_env_in_directory
+echo Yolo .Env:
+echo Creating `.env` (if not already exists) in `!TARGET_DIR!`
+if not exist %~dp0\.env ( copy nul %~dp0\.env  & robocopy %~dp0 !TARGET_DIR! .env /xc /xn /xo /nfl /ndl /njh /njs /nc /ns /np & del %~dp0\.env ) else ( robocopy %~dp0 !TARGET_DIR! .env /xc /xn /xo /nfl /ndl /njh /njs /nc /ns /np )
+goto :EOF
+
+:: Creates the .env if it doesn't already exists in chosen install directory (otherwise, does nothing)
+:create_env_in_repository
+echo Yolo .Env:
+echo Creating `.env` (if not already exists) in `%~dp0`
+if not exist %~dp0\.env ( copy nul %~dp0\.env ) else ( echo Already Exists )
+goto :EOF
+
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+::                                              Messages                                                              ::
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+::Prints a prompt for initial installing options
+:print_default
+echo Welcome to the yolo installer. 
+echo.
+echo Installation Options:
+echo.
+echo [Y] Yolo, Default installation to your home folder ( `%HOMEDRIVE%%HOMEPATH%\` )
+echo [N] Non-default install, Set custom install locations
+echo [C] Cancel, Do not install (exit this script)
+echo [O] Optional Files (advanced options) 
+echo.
+echo You probably want to use [Y].
+echo.
+goto :EOF
+
+:: Prints a prompt for folder installation
+:print_use_directory
+echo.
+echo Installation Folder Options:
+echo.
+echo [Y] Yes, Will create a seperate `yolo-ai-cmdbot\` folder to run yolo and you can delete the folder holding this `install.bat` after.
+echo [N] No , Will use the folder holding `install.bat` (`%~dp0`) to run yolo.
+echo.
+echo You probably want to use [Y].
+echo.
+goto :EOF
+
+:: Prints a prompt for folder installation location
+:print_install
+echo.
+echo Installation `yolo-ai-cmdbot\` folder Options:
+echo.
+echo [Y] Yes, Will use the current filepath of: `!INSTALL_DIR!`
+echo [N] No, Will let you paste in a file path
+echo.
+echo Note: If you manually move this folder you need to run `install.bat` again for a new `yolo.bat` file.
+echo.
+goto :EOF
+
+:: Prints a prompt for `yolo.bat` location
+:print_script
+echo.
+echo Installation `yolo.bat` File Options:
+echo.
+echo This file will let you run yolo from the directory it is installed using:
+echo `.\yolo.bat [Enter Prompt Here]` in terminal
+echo or `yolo [Enter Prompt Here]` if it is in a $PATH folder
+echo.
+echo [Y] Yes, Will use the current filepath of: `!SCRIPT_DIR!`
+echo [N] No, Will let you paste in a file path
+echo.
+echo You probably want to use [Y], you can manually move the `yolo.bat` file afterwards.
+echo.
+goto :EOF
+
+:: Prints a prompt for `.openai.apikey`
+:print_apikey
+echo.
+echo Installation `.openai.apikey` File Options:
+echo.
+echo This file can hold your openai apikey to let you run yolo
+echo.
+echo [Y] Yes, Create a `.openai.apikey` if it does not exist at `%HOMEDRIVE%%HOMEPATH%\`
+echo [N] No, Will skip this.
+echo.
+echo If you do not understand what this means, select [N]
+echo.
+goto :EOF
+
+:: Prints a prompt for `.yolo-safety-off`
+:print_safetyoff
+echo.
+echo Installation `.yolo-safety-off` File Options:
+echo.
+echo This file will remove the confirmation message before running commands given by yolo
+echo You can still have a confirmation message appear using the `-a` switch before your prompt:
+echo `.\yolo.bat -a [Enter Prompt Here]`
+echo.
+echo [Y] Yes, Create a `.yolo-safety-off` if it does not exist at `%HOMEDRIVE%%HOMEPATH%\`
+echo [N] No, Will skip this.
+echo.
+echo You probably want to use [N], this may cause you to delete/modify files you did not want to.
+echo If you do not understand what this means, select [N]
+echo.
+goto :EOF
+
+:: Prints a "Finished Installing" and usage message after installing
+:print_guide
+echo.
+echo Finished Installing Yolo...
+echo.
+echo You can run commands by being in the same directory as your `yolo.bat` file ( It is in `!SCRIPT_DIR!` ) with the following command:
+echo `.\yolo.bat [Enter Prompt Here]`
+echo You can also put your `yolo.bat` file into a $PATH directory and run it like so, instead:
+echo `yolo [Enter Prompt Here]`
+echo You can use the `-a` switch to make sure yolo asks you before running the returned command:
+echo `yolo -a [Enter Prompt Here]`
+echo Make sure to do this when deleting/modifying files/folders with safety off.
+echo.
+echo You should have `C:\Windows\System32` as a path in the $PATH environment variable but you can write the command `echo $env:PATH` into PowerShell for more options...
+set /p "wait=Press [Enter] for more:"
+if /i !createDIR!==1 ( call :print_bat_warning_directory )
+if /i !createDIR!==2 ( call :print_bat_warning_repository )
+set /p "wait=Press [Enter] for more:"
+call :print_apikey_guide
+echo.
+goto :EOF
+
+:print_bat_warning_directory
+echo.
+echo Warning:
+echo.
+echo If `!TARGET_DIR! is moved or deleted then the `yolo.bat` file will not work.
+echo You will need to run `install.bat` again to create a new `yolo.bat` file that links to the correct folder.
+echo However, `yolo.bat` can be moved from `!SCRIPT_DIR!` and still work.
+goto :EOF
+
+:print_bat_warning_repository
+echo.
+echo Warning:
+echo.
+echo If the `%~dp0` folder is moved or deleted then the `yolo.bat` file will not work.
+echo You will need to run `install.bat` again to create a new `yolo.bat` file that links to the correct folder.
+echo However, `yolo.bat` can be moved from `!SCRIPT_DIR!` and still work.
+goto :EOF
+
+:print_apikey_guide
+echo.
+echo Api Key:
+echo.
+echo You will need to provide your openai apikey to use yolo.
+echo You can get this at `https://platform.openai.com/account/api-keys` after logging in.
+echo - You can then put the apikey straight into a `.openai.apikey` file in `%HOMEDRIVE%%HOMEPATH%\` 
+echo (You can run this `install.bat` again and select `O`ptional Files to create a `.openai.apikey` file for you)
+echo -You can paste `OPENAI_API_KEY="[yourkey]"` into a `.env` file that should be in the folder yolo is installed in currently.
+if /i !createDIR!==1 ( echo `.env` should be in: !TARGET_DIR! )
+if /i !createDIR!==2 ( echo `.env` should be in: %~dp0 )
+echo -You can run `$env:OPENAI_API_KEY="[yourkey]"` in your terminal before using yolo in that terminal
+echo -If you run PowerShell as administrator you can then run `setx OPENAI_API_KEY "[yourkey]"` to permanently and use yolo in any terminal (you may need to reopen the terminal once).
+echo -Go to `Start` and search `edit environment variables for your account` and manually create the variable with name `OPENAI_API_KEY` and value `[yourkey]`
+goto :EOF