46 lines
718 B
Markdown
46 lines
718 B
Markdown
# ShellGenius
|
|
|
|
AI-Powered Local Shell Script Assistant using Ollama
|
|
|
|
## Features
|
|
|
|
- Generate shell scripts using natural language
|
|
- Review and explain existing scripts
|
|
- Interactive REPL mode
|
|
- Local privacy - all processing done locally via Ollama
|
|
- Support for multiple shell types (bash, zsh, sh)
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install shellgenius
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Generate a script
|
|
|
|
```bash
|
|
shellgenius generate "Create a backup script for /data directory"
|
|
```
|
|
|
|
### Review a script
|
|
|
|
```bash
|
|
shellgenius review script.sh
|
|
```
|
|
|
|
### Interactive REPL
|
|
|
|
```bash
|
|
shellgenius repl
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Configure Ollama host and model in `~/.config/shellgenius/config.yaml` or via environment variables.
|
|
|
|
## License
|
|
|
|
MIT
|