Hysen LabsMichael-A-Kuykendall/shimmy：README 来源编辑指南
基于 README、仓库元数据和许可证整理 Michael-A-Kuykendall/shimmy 的安装与核验路径。
项目定位
Michael-A-Kuykendall/shimmy 的 README 将项目描述为"⚡ Pure-Rust WebGPU inference engine , OpenAI-API compatible, GGUF native, runs on any GPU. No Python. No llama.cpp. Single binary."。本文只整理仓库能直接核验的内容，不把星标、Fork 或宣传语当成质量证明。README 在"🔒 Local Inference Without Dependencies 🚀"下的说明是：Shimmy will be free forever. No asterisks. No "free for now." No pivot to paid.。这给出的首先是项目边界，而不是已经完成的生产验证。
适用场景
从 README 的"💝 Support Shimmy's Growth"和相关条目看，读者可以先判断它是否解决自己的具体问题：$25/month: Bug prioritizer 🐛 - Priority support + name in SPONSORS.md。如果你的目标与这段说明不一致，就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名，方便回到一手来源核对。 README 还列出了另一条可核对的信息：$5/month: Coffee tier ☕ - Eternal gratitude + sponsor badge。这类原文条目可以帮助读者设计试运行步骤，但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"What Is Shimmy?"等段落中。可确认的线索包括：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.。这篇整理没有把未写出的架构、性能或安全边界补成结论；真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是： # 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 如果仓库没有提供命令，本文不会替它编造安装步骤，而是建议先打开 README 的"🔒 Local Inference Without Dependencies 🚀"部分，确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"What Is Shimmy?"段落提到：Under the hood it runs on Airframe, a pure-Rust WebGPU (WGSL) transformer engine built from scratch. No C++ toolchain, no backend flags, no compilation required. Version history lives in the CHANGELOG for engine release notes.。对于配置文件、环境变量、权限和数据目录，当前稿只记录来源明确的部分；未写明的默认值必须在测试环境中验证，并保留可回滚的配置副本。 同一部分还提到：$100/month: Corporate backer 🏢 - Logo placement + monthly office hours。