https://github.com/darrenldl/docfd
TUI multiline fuzzy document finder
https://github.com/darrenldl/docfd
document-management fuzzy-search grep-like indexed-search search tui
Last synced: 30 days ago
JSON representation
TUI multiline fuzzy document finder
- Host: GitHub
- URL: https://github.com/darrenldl/docfd
- Owner: darrenldl
- License: mit
- Created: 2022-03-02T01:31:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-15T23:37:38.000Z (30 days ago)
- Last Synced: 2025-05-16T00:27:21.009Z (30 days ago)
- Topics: document-management, fuzzy-search, grep-like, indexed-search, search, tui
- Language: OCaml
- Homepage:
- Size: 69.4 MB
- Stars: 256
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Docfd
TUI multiline fuzzy document finder
Think interactive grep for text files, PDFs, DOCXs, etc,
but word/token based instead of regex and line based,
so you can search across lines easily.
Docfd aims to provide good UX via integration with common text editors
and PDF viewers,
so you can jump directly to a search result with a single key press.
---
Interactive use
Non-interactive use
## Features
- Multithreaded indexing and searching
- Multiline fuzzy search of multiple files
- Content view pane that shows the snippet surrounding the search result selected
- Text editor and PDF viewer integration
- Editable command history - rewrite/plan your actions in text editor
- Search scope narrowing - limit scope of next search based on current search results
- Clipboard integration
## Why Docfd?
- You are interested in ad hoc searches and just want to run a command to get going
- You don't want to move everything into a central storage, and want to just keep your current folder structure
- You want a standalone TUI search tool that does not need to spin up a server and is also completely offline
- You want to script your search
## Why not Docfd?
- You don't want indexing
- You only care about simple searches, and grep and similar tools already suffice for you
## Installation
Statically linked binaries for Linux and macOS are available via
[GitHub releases](https://github.com/darrenldl/docfd/releases).
Docfd is also packaged on the following platforms for Linux:
- [opam](https://ocaml.org/p/docfd/latest)
- [AUR](https://aur.archlinux.org/packages/docfd-bin) (as `docfd-bin`)
- Nix (as `docfd`)
The only way to use Docfd on Windows right now is via WSL.
**Notes for packagers**: Outside of the OCaml toolchain for building (if you are
packaging from source), Docfd also requires the following
external tools at run time for full functionality:
- `pdftotext` from `poppler-utils` for PDF support
- `pandoc` for support of `.epub`, `.odt`, `.docx`, `.fb2`, `.ipynb`, `.html`, and `.htm` files
- `fzf` for some file selection menus
- `wl-clibpard` for clipboard support on Wayland
- `xclip` for clipboard support on X11
## Basic usage
The typical usage of Docfd is to either `cd` into the directory of interest
and launch `docfd` directly, or specify the paths as arguments:
```
docfd [PATH]...
```
The list of paths can contain directories.
Each directory in the list is scanned recursively for
files with the following extensions by default:
- For multiline search mode:
- `.txt`,
`.md`,
`.pdf`,
`.epub`,
`.odt`,
`.docx`,
`.fb2`,
`.ipynb`,
`.html`,
`.htm`
- For single line search mode:
- `.log`,
`.csv`,
`.tsv`
You can change the file extensions to use via
`--exts` and `--single-line-exts`,
or add onto the list of extensions via
`--add-exts` and `--single-line-add-exts`.
If the list `PATH`s is empty,
then Docfd defaults to scanning the
current directory `.`
unless any of the following is used:
`--paths-from`, `--glob`, `--single-line-glob`.
## Documentation
See [GitHub Wiki](https://github.com/darrenldl/docfd/wiki) for
more examples/cookbook, and technical details.
## Changelog
[CHANGELOG](CHANGELOG.md)
## Limitations
- File auto-reloading is not supported for PDF files,
as PDF viewers are invoked in the background via shell.
It is possible to support this properly
in the ways listed below, but requires
a lot of engineering for potentially very little gain:
- Docfd waits for PDF viewer to terminate fully
before resuming, but this
prohibits viewing multiple search results
simultaneously in different PDF viewer instances.
- Docfd manages the launched PDF viewers completely,
but these viewers are closed when Docfd terminates.
- Docfd invokes the PDF viewers via shell
so they stay open when Docfd terminates.
Docfd instead periodically checks if they are still running
via the PDF viewers' process IDs,
but this requires handling forks.
- Outside of tracking whether the PDF viewer instances
interacting with the files are still running,
Docfd also needs to set up file update handling
either via `inotify` or via checking
file modification times periodically.
## Acknowledgement
- Big thanks to [@lunacookies](https://github.com/lunacookies) and
[@jthvai](https://github.com/jthvai) for the many UI/UX discussions and
suggestions
- Demo gifs and some screenshots are made using [vhs](https://github.com/charmbracelet/vhs).
- [ripgrep-all](https://github.com/phiresky/ripgrep-all) was used as reference
for text extraction software choices
- [Marc Coquand](https://mccd.space) (author of
[Stitch](https://git.mccd.space/pub/stitch/)) for discussions and inspiration
of results narrowing functionality
- Part of the search syntax was copied from [fzf](https://github.com/junegunn/fzf)
- Command history editing workflow was inspired by Git interactive rebase workflow, e.g. `git rebase -i`
- [PDF corpora](https://github.com/pdf-association/pdf-corpora) from PDF association was used to stress test performance