Package: gia-shell-genie
Intentions--@STCGoal Derive another bot with special instructions based on GuillaumeAI's visions and current projects.original readme🧞‍♂️ GIA Shell GenieYour wishes are my commands.Shell Genie is a command-line tool that lets you interact with the terminal in plain English. You ask the genie what you want to do and it will give you the command you need.InstallationThe recommended way to install Shell Genie is usingpipx:Install Python 3.10 or higher.Installpipx.Install Shell Genie:pipx install shell-genieAlternatively, you can install it using pip:Install Python 3.10 or higher.Create a virtual environment in your preferred location:python -m venv .venvActivate the virtual environment:source .venv/bin/activateInstall Shell Genie:pip install shell-genieHow to useFirst, you need to initialize the tool by running the following command:shell-genieinitThis will prompt you to select a backend (eitheropenai-gpt3.5-turboorfree-genie) and provide any additional information that is required (e.g. your ownOpenAI APIkey foropenai-gpt3.5-turbo).Thefree-geniebackend is free to use. I'm hosting it, and as you can imagine I'm not a big corporation with unlimited money, so there's no guarantee that it will be available at all times. My goal is to generate a dataset of commands to fine-tune a model later on (this is mentioned during the initialization process).Once you have initialized the tool, you can start asking the genie what you want to do. For example, you may ask it to find all thejsonfiles in the current directory that are larger than 1MB:shell-genieask"find all json files in the current directory that are larger than 1MB"You'll see an output similar to this:Command:find.-name"*.json"-size+1M
Doyouwanttorunthiscommand?[y/n]:If you have questions about how the command works, you can ask the genie to explain it:shell-genieask"find all json files in the current directory that are larger than 1MB"--explainAnd you'll see an output similar to this:Command:find.-name"*.json"-size+1M
Description:Thiscommandwillsearchthecurrentdirectoryforall...(shortenedforbrevity)Doyouwanttorunthecommand?[y/n]:You can ask for commands in English or other languages, and the genie will try to provide you with a explanation in the same language.Run the command if you want to. If you're usingfree-genie, and you want to help improve the tool, you can provide feedback after you've run the command.Using an aliasIf you find that writingshell-genie askis too verbose, you can create an alias for the tool:echo"alias please='shell-genie ask'">>~/.bashrcsource~/.bashrcAnd now you can ask the genie usingplease:please"find all json files in the current directory that are larger than 1MB"ExamplesHere are two short videos showing how to use the tool:Ask genie for a commandAsk genie to explain a commandLimitationsAs you can imagine, not all the commands provided by the genie work as expected. If you request them, you might receive commands that could wreck your OS (e.g., rm -rf /). So, don't run commands if you don't understand their functions. If you choose to execute them despite not understanding them, do so at your own risk.LicenseThis project is licensed under the terms of the MIT license.