How-To Guides

Practical guides for getting things done with chops-search.

  • Install chops-search — Install the chops-search CLI from crates.io or from source. One binary, no wasm toolchain, no npm.
  • Add search to every page — Two template lines mount a Cmd-K search overlay on your whole site, plus how to wire your header's search icon to open it.
  • Drive your theme's search UI — Run chops-search in inline mode against your theme's existing search markup instead of the self-mounted overlay.
  • Deploy with correct caching — The _headers file for Cloudflare and Netlify, the CSP directives wasm needs, and the three deployment gotchas that cost afternoons.
  • Reindex on every push — A GitHub Actions recipe that rebuilds the search index whenever content changes, with the model cached against its lockfile and recall gated before deploy.
  • Manage the embedding model — Fetch, lock, and verify the model2vec model, and what to re-check when you change dims.
  • Enable shell completion — Turn on dynamic tab-completion for chops-search in fish, zsh, or bash.