fz-browse is a general-purpose command-line fuzzy finder.
npm install fz-browsefz-browse is a general-purpose command-line fuzzy finder.
fz-browse is fzf-like tool but view search results on browser.
https://user-images.githubusercontent.com/19714/163715237-e16cfafe-5e11-4d20-9398-1fbb5e845f7e.mp4
npm install --global fz-browse
Usage
$ fz-browse [option]
Options
--run [String] Run command
--preview [String] Preview command
--cwd [String:Path] Current working directory
--query [String] Default search query
--open [Boolean] If it is set, open browser automatically
--browser [String] for opening browser name: "google chrome", "firefox", "microsoft edge"
--displayItemLimit [Number] Limit count for display search results
Examples
# Search text contents
fz-browse --run $'rg --ignore-case {input} --json | jq \'if .type == "begin" or .type == "match" then . else empty end | [.data.path.text, .data.lines.text] | @tsv\' -r' --preview "rg --context 5 {input} {target}"
# Search PDF/epub books
fz-browse --run $'rga --ignore-case {input} --json | jq \'if .type == "begin" or .type == "match" then . else empty end | [.data.path.text, .data.lines.text] | @tsv\' -r' --preview "rga --context 5 {input} {target}" --cwd "/Path/To/Your/BookDir"
- --run: fz-browse execute the run command when input search keywords
--run command should output following file path by line.
``
/path/to/file
/path/to/file
/path/to/file
Also, support following TSV list by line.
If you want to display content of the file in search result, --run command should output pattern.
`tsv`
/path/to/fileA
/path/to/fileA\tContent of the file A1
/path/to/fileA\tContent of the file A2
/path/to/fileA\tContent of the file A3
/path/to/fileB
/path/to/fileB\tContent of the file B1
It will be converted to following structure on view.
`html/path/to/fileA
Content of the file A1
Content of the file A2
Content of the file A3
Content of the file B1
:memo: Empty TSV line will be ignored.
tsv
/path/to/fileA
/path/to/fileA\tContent of the file A1
/path/to/fileA\tContent of the file A2
/path/to/fileA\tContent of the file A3
\t # This line will be ignored
`$3
-
: fz-browse execute the preview command when click the search result--preview command should output following content by line.`
content A
content B
content C
It will be converted to following structure on view.
html
content A
content B
content C
`Architecture
Recipes
Please add your Recipes to Wiki!:
$3
Show ripgrep search results
shell
fz-browse --run $'rg --ignore-case {input} --json | jq \'if .type == "begin" or .type == "match" then . else empty end | [.data.path.text, .data.lines.text] | @tsv\' -r' --preview "rg --context 5 {input} {target}"
`$3
Show ripgrep-all search results
- Requirements:
- ripgrep-all
- jq
shell
fz-browse --run $'rga --ignore-case {input} --json | jq \'if .type == "begin" or .type == "match" then . else empty end | [.data.path.text, .data.lines.text] | @tsv\' -r' --preview "rga --context 5 {input} {target}" --cwd "/Path/To/Your/BookDir"
`
Description
It means that convert only "begin" and "match" JSON line to TSV.
rga test --json | jq 'if .type == "begin" or .type == "match" then
. # Pass it-self to next pipe
else
empty # remove this live
end | [.data.path.text, .data.lines.text] | @tsv'
$3
and --browser allow you to open a browser.`shell
fz-browse --run $'rg --ignore-case {input} --json | jq \'if .type == "begin" or .type == "match" then . else empty end | [.data.path.text, .data.lines.text] | @tsv\' -r' --preview "rg --context 5 {input} {target}" --open --browser "google chrome"
`$3
Search Images using exiftool.
- Requirements:
- ExifTool
shell
fz-browse --run $'find -E . -iregex ".*\.(jpg|gif|png|jpeg)$" -print0 | xargs -0 exiftool -q -m -p \'$Directory/$Filename $DateTimeOriginal $Comment\' | grep {input} | awk \'{print $1}\'' --preview "echo {target}"
``https://user-images.githubusercontent.com/19714/163715229-e05b8a7e-7708-41a1-bd07-316a177d9f35.mp4
- PDF
- epub
- Image: png,jpe,jpeg,webp,gif
git clone https://github.com/azu/fz-browse
cd fz-browse
yarn install
# using vite server
NODE_ENV=develop PORT=3000 node ./cli.mjs ...
MIT ©️ azu