[ANN] Docfd: TUI fuzzy document finder 0.2.3

[darrenldl]

I’m happy to share Docfd, an interactive TUI tool finding the text file you need quickly.

Repo
Statically linked binary

(Will submit to opam when time frees up a bit.)

Screenshots and interface

Searching left is in the repo root

Searching [github] in the repo root

The TUI is divided into three sections:

• Left is the list of documents which satisfy the search constraints
• Top right is the preview of the document
• Bottom right is the ranked content search result list
• Bottom bar is the search interface

Controls

Docfd operates in modes, the initial mode is NAVIGATION mode

NAVIGATION mode

• Scroll down the document list
  • j or down arrow
  • Scroll down with mouse wheel when hovering above the area
• Scroll up the document list
  • k or up arrow
  • Scroll up with mouse wheel when hovering above the area
• Scroll down the content search result list
  • Shift+j or Shift+Down arrow
  • Scroll down with mouse wheel when hovering above the area
• Scroll up the document list
  • Shift+k or Shift+Up arrow
  • Scroll up with mouse wheel when hovering above the area
• Open document
  • Enter
    • Docfd tries to use $VISUAL first, if that fails then Docfd tries $EDITOR
• Switch to CONTENT SEARCH mode
  • /
• Exit Docfd
  • q or Ctrl+c

CONTENT SEARCH mode

• Content search field is active in this mode
• Enter to confirm search constraints and exit search mode

Limitations

• Docfd is focused on typical desktop use, so simplicity of components is often favoured over strict performance
  • That being said, the in-memory index and search should still be performant enough
• No on-disk index is built

[darrenldl]

Docfd 0.2.6 has just been released.

• Some limits were put in places to speed up content search and avoid it becoming very slow in large documents
• Adjusted the command line to accept multiple paths, each path can be file or directory
• Single file mode is added (see screenshots below)

Searching is left after docfd README.md

Searching [github] after docfd README.md

Feel free to leave feedback!