ShellOracle 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!
Show your support for ShellOracle and keep an eye out for exciting new developments by clicking the ⭐ and a 👀!
Key features of ShellOracle include:
- Seamless shell command generation from written descriptions
- Command history for easy reference
- Unix pipe support for advanced command chaining
- Self-hosted for full control over your environment
- Highly configurable to adapt to your preferences
Installing ShellOracle is easy!
- pipx install the
shelloraclepackagepipx install shelloracle
- Configure ShellOracle and follow the prompts
shor configure
- Refer to the providers section for specific details regarding your chosen provider.
Upgrading to the latest version of ShellOracle is just as simple!
- pipx upgrade the
shelloraclepackagepipx upgrade shelloracle
Installation with pip is supported, however, pipx is preferred for its automatic environment isolation.
ShellOracle is designed to be used as a BASH/ZSH widget activated by the CTRL+F keyboard shortcut.
- Press CTRL+F
- Describe your command
- Press Enter
The generated command will be inserted into your shell prompt after a brief processing period.
ShellOracle can be run as a Python module with python3 -m shelloracle or using its entrypoint shor, however,
running ShellOracle with this method will not automatically insert the result into your shell prompt.
- If you press CTRL+F with text in your ZLE buffer, all text left of your cursor will carry over to your ShellOracle prompt.
- ⬆️ arrow and ⬇️ arrow cycle through your prompt history.
- ShellOracle can be chained with other commands; try:
echo "find all the python files in my cwd" | shor
Before using ShellOracle with Ollama, pull the model you chose in the configure step.
For example, if you chose dolphin-mistral, run:
ollama pull dolphin-mistralRefer to the Ollama docs for installation, available models, and usage.
To use ShellOracle with the OpenAI provider, create an API key. Edit
your ~/.shelloracle/config.toml to change your provider and enter your API key.
Refer to the LocalAI docs for installation, available models, and usage.
ShellOracle's configuration is your gateway to tailoring the utility to match your preferences and requirements.
The ~/.shelloracle/config.toml file serves as the control center for customizing various aspects of ShellOracle's
behavior.
ShellOracle supports BASH and ZSH on macOS and Linux.
For cloud providers like OpenAI, there are no hardware requirements.
If running locally, refer to your model for hardware requirements.
Encountered problems? File an issue. Feature requests are welcome, and contributions can be made by opening a pull request.
This software is licensed under the GPLv3 license.