REFERENCE · CLI

CLI reference

Native CLI

Syntax is kfind [OPTIONS] QUERY [PATH].... Core compile options are --pos, --expand, --boundary, --literal, --max-gap, and --unicode-normalization.

File options control encoding, globs, types, ignore rules, threads, and context. Output supports --json, --explain-query, --explain-match, and --sort path.

kfind --pos verb --boundary smart 걷다 src
kfind --embedded --boundary any --json 'n:사용자 v:검증하다' src

npm CLI

On Node.js 20 or later, @kfind/kfind installs the kfind command. It supports --expand, --boundary, --pos, --normalization, --max-gap, --literal, and --json.

npx, pnpm dlx, and Yarn 2+ yarn dlx run the same command without a local installation.

npx @kfind/kfind 걷다 README.md
pnpm dlx @kfind/kfind --pos verb 걷다 src
yarn dlx @kfind/kfind --json 권한 docs
npx @kfind/kfind 'v:걷다|n:사용자' src

Feature differences

The npm CLI supports recursive UTF-8 traversal, stdin, text, and JSON Lines. It loads the packaged enriched predicates and lazily loads compact components for queries that need them.

Use the native CLI for full POS, Git ignore, EUC-KR, context, TUI, explain output, and agent integration installation or removal.