Package: shelloracle
ShellOracleShellOracle is an innovative terminal utility designed for intelligent shell command generation, bringing a new level of
efficiency to your command-line interactions. ShellOracle currently supports Ollama, LocalAI, and OpenAI!Explore our dynamic features and look forward to more exciting updates by giving us a ⭐ and a 👀Table of ContentsIntroductionFeaturesInstallationUsageProvidersConfigurationSystem RequirementsFeedbackIntroductionMeet ShellOracle—a handy tool that makes working with the command line a bit smoother. This terminal utility lets you
create shell commands by describing what you want to do in plain language. ShellOracle simplifies the process of
crafting complex commands by removing the need to google and comb man pages.Why ShellOracle?No More Memorizing:Forget about remembering complex shell commands. Just tell ShellOracle what you need, and
it'll generate the command for you.Save Time, Stay Focused:Say goodbye to manual command crafting. ShellOracle helps you save time and concentrate
on what really matters by using natural language descriptions.Adaptable to Your Needs:Whether it's a quick one-liner or a sequence of commands, ShellOracle is flexible. It
supports Unix pipes and keeps track of your command history.Your Control, Your Way:Run ShellOracle as a self-hosted utility to have complete control. Tailor it to your
preferences and make it work just the way you want.Give it a try and see how it fits into your workflow!FeaturesKey features of ShellOracle include:Seamless shell command generation from written descriptionsCommand history for easy referenceUnix pipe support for advanced command chainingSelf-hosted for full control over your environmentHighly configurable to adapt to your preferencesInstallationInstalling ShellOracle is easy!Pip install theshelloraclepackagepython3-mpipinstallshelloracleConfigure ShellOracle withshelloracle configureand follow the promptspython3-mshelloracleconfigureRefer to theproviderssection for specific details regarding your chosen provider.UsageShellOracle is designed to be used as a BASH/ZSH widget activated by the CTRL+F keyboard shortcut.Press CTRL+FDescribe your commandPress EnterThe generated command will be inserted into your shell prompt after a brief processing period.ProvidersOllamaBefore using ShellOracle with Ollama, pull the model you chose in the configure step.
For example, if you chosecodellama:13b, run:ollamapullcodellama:13bRefer to theOllama docsfor installation, available models, and usage.OpenAITo use ShellOracle with the OpenAI provider, create anAPI key. Edit
your~/.shelloracle/config.tomlto change your provider and enter your API key.LocalAIRefer to theLocalAI docsfor installation, available models, and usage.Other ways to run ShellOracleShellOracle can be run as a Python module withpython3 -m shelloracleor using its entrypointshor; however,
there are a few caveats with this method:Ensure your~/.local/bindirectory is added to your PATH variable for the entrypoint to work.Running ShellOracle with this method will not automatically insert the result into your shell prompt.TipsIf you press CTRL+F with text in your ZLE buffer, all text left of your cursor will carry over to your ShellOracle
prompt.UP_ARROW and DOWN_ARROW cycle through your prompt history.ShellOracle can be chained with other commands; try:echo "find all the python files in my cwd" | shorConfigurationShellOracle's configuration is your gateway to tailoring the utility to match your preferences and requirements.
The~/.shelloracle/config.tomlfile serves as the control center for customizing various aspects of ShellOracle's
behavior.System RequirementsSoftwareShellOracle supports BASH and ZSH on macOS and Linux.HardwareFor cloud providers like OpenAI, there are no specific system requirements.If self-hosting, system requirements vary based on the model used. Refer to the Ollama model registry for more
information.FeedbackEncountered problems?File an issue. Feature requests are welcome,
and contributions can be made by opening a pull request.