Michael-A-Kuykendall/shimmy: README-based editorial guide
A guide grounded in the README, repository metadata, and license for installing and checking Michael-A-Kuykendall/shimmy.
Project scope
Michael-A-Kuykendall/shimmy describes itself in the README as "⚡ Pure-Rust WebGPU inference engine , OpenAI-API compatible, GGUF native, runs on any GPU. No Python. No llama.cpp. Single binary.". This article keeps to facts that can be checked in the repository. Stars, forks, and promotional badges are signals of attention, not proof of quality. Under "🔒 Local Inference Without Dependencies 🚀", the README says: Shimmy will be free forever. No asterisks. No "free for now." No pivot to paid.. That establishes the project's stated boundary, not a production test.
Suitable use cases
The README's "💝 Support Shimmy's Growth" section gives a useful starting point for deciding whether the project fits: $25/month: Bug prioritizer 🐛 - Priority support + name in SPONSORS.md. If that problem is not yours, popularity is a poor reason to adopt it. Project names, commands, and component names are kept as written so a reader can return to the primary source without guessing at terminology. Another checkable README item is: $5/month: Coffee tier ☕ - Eternal gratitude + sponsor badge. It can shape a first test, but it does not replace testing in the intended environment.
How it works
The operating model is spread across sections such as "What Is Shimmy?". The source evidence includes: Shimmy is a single-binary that provides 100% OpenAI-compatible endpoints for GGUF models. Point your existing AI tools to Shimmy and they just work , locally, privately, and free.. This article does not turn missing architecture, performance, or security details into claims. A real deployment still needs a look at the repository layout, configuration files, and release history.
Installation and first run
Start installation from the README's documented entry point. A command that can be checked in the source is: # 1) Download pre-built binary (Windows example) curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-windows-x86_64.exe -o shimmy.exe # 2) Point it at a GGUF model set SHIMMY_BASE_GGUF=C:\path\to\model.gguf && ./shimmy.exe serve & # 3) See registered models ./shimmy list # 4) Smoke test the OpenAI API curl -s http://127.0.0.1:11435/v1/chat/completions \ -H 'Content-Type: application/json' \ -d '{"model":"tinyllama-1.1b","messages":[{"role":"user","conten When the README contains no runnable command, this article does not invent one. Open its "🔒 Local Inference Without Dependencies 🚀" section and confirm system dependencies, default ports, and first-run initialization before using a public server.