Getting started
Matchmaker (binary mm) is a fast, configurable and intuitive fuzzy searcher for the terminal. It filters rows piped into it, lets you pick one or more with the keyboard (or mouse), and prints the selections back to stdout.
Skeleton — this page is part of the documentation skeleton: structure plus verified facts. Full prose to be written.
Overview
- Fuzzy matching with fzf-style scoring, smart case, and word-boundary awareness (see Queries & matching).
- Keyboard-first TUI with an optional preview panel (see The interface).
- Input is piped in, or produced by a configured command (see Input & data sources).
- Output is printed as the full line (or per-column templates) to stdout.
- Everything is configurable through a TOML config file, CLI overrides, and presets (see Configuration).
Installation
To write: platform install instructions (cargo install, install script, brew/npm packaging). The release binary is named mm; release assets follow matchmaker-cli-<arch>-<os> naming.
First run
mmwith no arguments runs the default command (files in the current directory) when stdin is a terminal.- Pipe a command's output into it:
fd . | mmorfind . -print0 | mm -- -0style patterns. - Type to filter, press
enterto accept; the selected line is printed to stdout. mm --test-keysprints key events (for validating terminal key reporting).mm --doc optionsprints the command-line reference in the terminal.
Getting help
mm --helplists all flags.mm --doc <options|binds|template|other>displays the built-in documentation.- See Command line, Binds & actions, Templates, and Queries & misc for the same content on the web.
Next steps
- Core workflows — common usage patterns.
- Configuration — write your first config file with
mm --dump-config. - Presets & workflows — ready-made config bundles.
