https://github.com/day50-dev/zummoner
Summon AI at your command line with a convenient keystroke
https://github.com/day50-dev/zummoner
zsh zsh-plugin
Last synced: 7 months ago
JSON representation
Summon AI at your command line with a convenient keystroke
- Host: GitHub
- URL: https://github.com/day50-dev/zummoner
- Owner: day50-dev
- License: mit
- Created: 2025-05-22T16:08:50.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-06-02T16:31:09.000Z (8 months ago)
- Last Synced: 2025-06-03T06:26:57.980Z (8 months ago)
- Topics: zsh, zsh-plugin
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 35
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zummoner: ✨ The Zsh Spellbook ✨
**Invoke the power of the command line with a whisper!**
Tired of remembering complex commands? 🧙♂️ Zummoner is a Zsh plugin that *summons* the right command for you, using the magic of a Large Language Model (LLM). Just describe what you want to do, and Zummoner does the rest!
## Features - The Enchantments 🪄
* **Command Conjuration:** Describe your task in plain English, and Zummoner generates the command. ✨
* **System Aware:** Knows your system (`uname -a`) and user for tailored spells. 🤖
* **Modern Magic:** Prefers modern tools like `homectl`, `ip`, `systemctl`, and `journalctl`. 🚀
* **Safety First:** Commands are vetted for reliability (but *always* review before running!). 🛡️
* **Customizable LLM:** Pick your favorite LLM model! 🧠
* **Seamless Integration:** Works directly within your Zsh shell. 🐚
## Installation - Binding the Spirit 🔗
You cann zplug, zinit, zgen it ... it's the right format orrrr manually:
```bash
git clone https://github.com/day50-dev/zummoner.git $HOME/.local/zummoner
echo source \$HOME/.local/zummoner/zummoner.zsh >> $HOME/.zshrc
source $HOME/.zshrc
```
**Keybinding:** Zummoner uses `^Xx` (Ctrl+x, then x) by default. It'll let you know if that key is already taken!
## Usage - Uttering the Incantation 🗣️
1. Type what you want to do (e.g., "list all files in the current directory sorted by size").
2. Press `^Xx`.
3. Zummoner will show the command!
4. Press Enter to execute. 💥
## Caveats - A Little Magic Caution ⚠️
* **LLM Required:** Zummoner needs access to [simon w's llm](https://github.com/simonw/llm).
* **Network Connection:** Requires internet access to reach the LLM.
* **Review Commands:** Always check the generated command, *especially* if it uses `sudo`!
* **System Differences:** Commands may need tweaking depending on your Linux distribution.
## The future!
This project was a prototype [for something much more ambitious](https://news.ycombinator.com/item?id=44112949) of what is now called [ono](https://onolang.com/).