Metadata-Version: 2.1
Name: shelloracle
Version: 0.2.1
Summary: ShellOracle is a pluggable terminal utility that takes a natural language description of a command and substitutes it into your terminal buffer.
Author-email: Daniel Copley <djcopley@users.noreply.github.com>
Project-URL: Homepage, https://github.com/djcopley/ShellOracle
Project-URL: Repository, https://github.com/djcopley/ShellOracle.git
Project-URL: Issues, https://github.com/djcopley/ShellOracle/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: MacOS
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx
Requires-Dist: prompt-toolkit
Requires-Dist: tomlkit

# ShellOracle 

![ShellOracle](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExdnJncm1mc2N5dzYxMDZyZXQ0ZWdudHZqY2YyMThqZHdvcW1ldHRzOCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/bvHanmQMfOe3sVq4jM/giphy.gif)

### Usage

More streamlined installation and platforms coming soon so ⭐ and 👀️ to stay in the loop.

Currently, ShellOracle only supports zsh on macOS. The installation process is not productized yet, so here are the
general steps to get it up and running.

1. Install [Ollama](https://ollama.ai/)
2. Install shelloracle
   ```zsh
   pip3 install shelloracle
   ``` 
3. Source the zsh configuration
   ```zsh
   source shell/shelloracle.zsh
   ```
4. Use ctrl+f to open the prompt
