# node-fzf > fzf ( junegunn/fzf ) inspired cli utility for node Latest version **0.14.0** (published 2025-05-02) · MIT license · 0 weekly downloads ## Install ```sh npm install node-fzf pnpm add node-fzf yarn add node-fzf bun add node-fzf ``` Provides the command `nfzf`. ## Health **Score 25/100 (F)** — status: maintenance-mode. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 0.14.0 | | Published | 2025-05-02 | | First published | 2018-03-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 7 | | Unpacked size | 44.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 73 | | Author | talmobi | | Maintainers | talmobi | | Keywords | node-fzf, fzf, fuzzy, list, search, cli | ## Links - npm: https://www.npmjs.com/package/node-fzf - Repository: https://github.com/talmobi/node-fzf - Homepage: https://github.com/talmobi/node-fzf#readme - Issues: https://github.com/talmobi/node-fzf/issues - npm.io page: https://npm.io/package/node-fzf ## Dependencies (7) - [ttys](https://npm.io/package/ttys.md) 0.0.3 - [redstar](https://npm.io/package/redstar.md) 0.0.2 - [keypress](https://npm.io/package/keypress.md) ~0.2.1 - [minimist](https://npm.io/package/minimist.md) ~1.2.5 - [picocolors](https://npm.io/package/picocolors.md) ~1.1.1 - [string-width](https://npm.io/package/string-width.md) ~2.1.1 - [restore-cursor](https://npm.io/package/restore-cursor.md) ~3.1.0 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 0.14.0 (latest) — 2025-05-02 - 0.13.1 — 2024-09-27 - 0.12.0 — 2024-09-25 - 0.11.0 — 2021-05-30 - 0.10.0 — 2021-05-29 - 0.9.0 — 2021-02-08 - 0.8.0 — 2020-08-06 - 0.7.0 — 2020-07-15 - 0.6.1 — 2020-03-13 - 0.6.0 — 2020-03-10 - 0.5.3 — 2020-01-31 - 0.5.2 — 2020-01-31 - 0.5.1 — 2020-01-15 - 0.5.0 — 2020-01-14 - 0.4.5 — 2020-01-13 - … 16 more at https://npm.io/package/node-fzf/versions ## README [![npm](https://img.shields.io/npm/v/node-fzf.svg?maxAge=3600&style=flat-square)](https://www.npmjs.com/package/node-fzf) [![npm](https://img.shields.io/npm/dm/node-fzf.svg?maxAge=3600)](https://www.npmjs.com/package/node-fzf) [![npm](https://img.shields.io/npm/l/node-fzf.svg?maxAge=3600&style=flat-square)](https://github.com/talmobi/node-fzf/blob/master/LICENSE) ![mac](https://github.com/talmobi/node-fzf/actions/workflows/macos-node.js.yml/badge.svg?branch=master) ![ubuntu](https://github.com/talmobi/node-fzf/actions/workflows/ubuntu-node.js.yml/badge.svg?branch=master) ![windows](https://img.shields.io/badge/windows-unable%20to%20test%20automatically-yellow?style=flat) # node-fzf [fzf](https://github.com/junegunn/fzf) inspired fuzzy CLI list selection 🎀 ![](https://i.imgur.com/SFUV5nW.gif) ## Easy to use #### CLI usage ```bash npm install -g node-fzf # by default (TTY mode) will glob list of current dir files nfzf # using pipes find . | nfzf | xargs cat | less mpv "`find ~/Dropbox/music | nfzf --exact --keep-right`" --no-audio-display alias merge="git branch | nfzf | xargs git merge" alias checkout="git branch | nfzf | xargs git checkout" ``` #### API usage ##### promises ```js const nfzf = require( 'node-fzf' ) // if you only care about r.query // nfzf.getInput( label ) const opts = { /* required */ list: [ 'whale', 'giraffe', 'monkey' ], /* (optional) */ // filtering mode (user can change modes by pressing ctrl-s) mode: 'fuzzy' || 'normal', /* (optional) */ // prefill user input query: '', /* (optional) */ // If there is only one match for the initial query (--query), do not // start interactive finder and automatically select the only match selectOne: false, /* (optional) */ // % of screen to use to display results (minimum/defaults to 6 rows) height: 0, // ex: 40 for 40%, 100 for 100% /* (optional) */ // text before each displayed line, list index supplied as arg prelinehook: function ( index ) { return '' }, /* (optional) */ // text after each displayed line, list index supplied as arg postlinehook: function ( index ) { return '' } } ;( async function () { // opens interactive selection CLI // note! this messes with stdout so if you are // writing to stdout at the same time it will look a bit messy.. const result = await nfzf( opts ) const { selected, query } = result if( !selected ) { console.log( 'No matches for:', query ) } else { console.log( selected.value ) // 'giraffe' console.log( selected.index ) // 1 console.log( selected.value === opts.list[ selected.index ] ) // true } } )() // can also add more items later.. setInterval( function () { opts.list.push( 'foobar' ) // an .update method has been attached to the object/array // that you gave to nfzf( ... ) opts.update( list ) }, 1000 ) ``` ##### callbacks ```js const nfzf = require( 'node-fzf' ) // if you only care about r.query // nfzf.getInput( label, callback ) const list = [ 'whale', 'giraffe', 'monkey' ] // opens interactive selection CLI // note! this messes with stdout so if you are // writing to stdout at the same time it will look a bit messy.. const api = nfzf( list, function ( result ) { const { selected, query } = result if( !selected ) { console.log( 'No matches for:', query ) } else { console.log( selected.value ) // 'giraffe' console.log( selected.index ) // 1 console.log( selected.value === list[ selected.index ] ) // true // the api is a reference to the same argument0 object // with an added .update method attached. console.log( list === api ) // true console.log( list.update === api.update ) // true } } ) // can also add more items later.. setInterval( function () { list.push( 'foobar' ) api.update( list ) }, 1000 ) ``` #### Keyboard ```bash switch between search modes (fuzzy, normal/exact) ,,down scroll down ,,up scroll up scroll down by page size scroll up by page size jump to start of input jump to end of input (and toggles --keep-right) ,, cancel , trigger callback/promise with current selection and exit delete last word from input jump back a word jump forward a word delete last input character ``` ## About [fzf](https://github.com/junegunn/fzf) inspired fuzzy CLI list selection thing for node. ## Why easy fuzzy list selection UI for NodeJS CLI programs. ## How Mostly [picocolors](https://github.com/alexeyraspopov/picocolors) for dealing with the terminal rendering ~~Mostly [cli-color](https://github.com/medikoo/cli-color) for dealing with the terminal rendering~~ and [ttys](https://github.com/TooTallNate/ttys) to hack the ttys to simultaneously read from non TTY stdin and read key inputs from TTY stdin -> So that we can get piped input while also at the same time receive and handle raw keyboard input. ## Used by [yt-play](https://github.com/talmobi/yt-play) [yt-search](https://github.com/talmobi/yt-search) ## Similar [fzf](https://github.com/junegunn/fzf) even though it doesn't work in NodeJS directly is all-in-all a better tool than this piece of crap :) Highly recommend~ [ipt](https://github.com/ruyadorno/ipt) - similar node based solution ## Test ```bash npm test ``` --- _Source: https://npm.io/package/node-fzf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._