unch

Local-first semantic code search for code symbols and docs.

unch lets you find functions, methods, types, classes, interfaces, and attached docs by describing what the code does, not by remembering the exact name or file path.

Everything stays local by default. Remote publishing is optional.

If you only want the docs site in Mintlify, connect unch-docs rather than the main unch code repository.

Installation

Install with npm, or choose Homebrew, shell installer, PowerShell, or go install.

Quick Start

Index a repo and run your first search in under a minute.

Commands

Full reference for index, search, and remote.

CI & Remote

Publish and reuse indexes through GitHub Actions when you need shared state.

Pick a workflow

Local-first

unch index --root .
unch search "create a new router"
unch search --details "get path variables from a request"

OpenRouter

unch auth openrouter --token sk-or-...
unch index --root . --provider openrouter --model openai/text-embedding-3-small
unch search --provider openrouter --model openai/text-embedding-3-small "create a new router"

Shared via CI

unch create ci
unch bind ci https://github.com/owner/repo
unch remote sync
unch search "create a new router"

What you get

Symbol-aware indexing

Index top-level API objects and attached docs instead of raw lines only.

Local-first by default

Keep indexing and search on your machine unless you explicitly publish remote state.

Semantic and lexical retrieval

Use auto, semantic, or lexical mode depending on how specific the query is.

Optional remote reuse

Publish through .github/workflows/unch-index.yml when you want a shared cache.

Typical flow

1. Install unch

   Start with Installation.

2. Index a repository

   Run unch index --root . inside the project you want to search.

3. Search by behavior

   Describe what the code does instead of typing the exact symbol name.

4. Inspect details when needed

   Add --details to show kind, signature, docs, and body context.

Start here

• Installation
• Quick Start
• Commands
• CI & Remote Indexing