Skip to content

day50-dev/Zummoner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

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!

440177965-01488c16-fb68-4fdb-a7ea-76e12499641d

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:

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.
  • 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 of what is now called ono.

About

Summon AI at your command line with a convenient keystroke

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages