Metadata-Version: 2.1
Name: shllm
Version: 0.0.4
Summary: Natural langauge shell commands.
Author: Ryan Hendry
Author-email: ryanhendry123@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: openai (>=1.51.0,<2.0.0)
Requires-Dist: pyperclip (>=1.9.0,<2.0.0)
Description-Content-Type: text/markdown

<p align="center">
    <a href="https://pypi.org/project/shllm/">
        <img src="https://img.shields.io/pypi/v/shllm?color=3772A5" /></a>
</p>

# shllm
  
Generate shell commands using natural langauge.

## Installation

```bash
echo "export SHLLM_OPENAI_KEY={{OpenAI API Key}}" >> ~/.zshrc
pipx install shllm
```

## Usage
```bash
shllm {{what you want to do}}
```
### Example
```bash
shllm show how many gigabytes of free space I have left on my hard drive
Command to be copied to clipboard: df -h . | awk 'NR==2 {print $4}'
Do you want to copy this command to the clipboard? (y/n): y
Command has been copied to the clipboard.
```
