docfd

Dokumen

Pencari dokumen fuzzy multiline TUI

Pikirkan grep interaktif untuk file teks, PDF, DOCX, dll, tetapi berbasis kata/token, bukan berbasis regex dan baris, sehingga Anda dapat mencari antar baris dengan mudah.

Docfd bertujuan untuk memberikan UX yang baik melalui integrasi dengan editor teks umum dan penampil PDF, sehingga Anda dapat langsung membuka hasil pencarian dengan menekan satu tombol.

---

Fitur

• Pengindeksan dan pencarian multithread

• Pencarian fuzzy multiline dari banyak file

• Panel tampilan konten yang memperlihatkan cuplikan seputar hasil pencarian yang dipilih

• Integrasi editor teks dan penampil PDF

• Riwayat perintah yang dapat diedit - tulis ulang/rencanakan tindakan Anda di editor teks

• Penyempitan cakupan pencarian - membatasi cakupan pencarian berikutnya berdasarkan hasil pencarian saat ini

• Integrasi papan klip

Instalasi

Biner yang terhubung secara statis untuk Linux dan macOS tersedia melalui rilis GitHub.

Docfd juga dikemas pada platform berikut untuk Linux:

• opam
• AUR (sebagai docfd-bin ) oleh kseistrup
• Nix (seperti docfd ) oleh Chewblacka

Satu-satunya cara untuk menggunakan Docfd di Windows saat ini adalah melalui WSL.

Catatan untuk pembuat paket : Di luar rantai alat OCaml untuk pembuatan (jika Anda mengemas dari sumber), Docfd juga memerlukan alat eksternal berikut pada waktu proses untuk fungsionalitas penuh:

• pdftotext dari poppler-utils untuk dukungan PDF
• pandoc untuk dukungan file .epub , .odt , .docx , .fb2 , .ipynb , .html , dan .htm
• fzf untuk menu pemilihan file
• wl-clibpard untuk dukungan clipboard di Wayland
• xclip untuk dukungan clipboard pada X11

Penggunaan dasar

Penggunaan umum Docfd adalah dengan melakukan cd ke direktori yang diinginkan dan meluncurkan docfd secara langsung, atau menentukan jalur sebagai argumen:

 docfd [PATH]...

Daftar jalur dapat berisi direktori. Setiap direktori dalam daftar dipindai secara rekursif untuk mencari file dengan ekstensi berikut secara default:

• Untuk mode pencarian multibaris:
  • .txt , .md , .pdf , .epub , .odt , .docx , .fb2 , .ipynb , .html , .htm
• Untuk mode pencarian satu baris:
  • .log , .csv , .tsv

Anda dapat mengubah ekstensi file untuk digunakan melalui --exts dan --single-line-exts , atau menambahkan ke daftar ekstensi melalui --add-exts dan --single-line-add-exts .

Jika daftar PATH s kosong, maka Docfd secara default memindai direktori saat ini . kecuali salah satu dari berikut ini digunakan: --paths-from , --glob , --single-line-glob .

Dokumentasi

Lihat GitHub Wiki untuk contoh/buku masak lebih lanjut, dan detail teknis.

Keterbatasan

• Pemuatan ulang file secara otomatis tidak didukung untuk file PDF, karena penampil PDF dipanggil di latar belakang melalui shell. Hal ini dapat didukung dengan baik melalui cara-cara yang tercantum di bawah ini, namun memerlukan banyak rekayasa untuk menghasilkan keuntungan yang sangat kecil:

  • Docfd menunggu hingga penampil PDF berhenti sepenuhnya sebelum melanjutkan, namun hal ini melarang melihat beberapa hasil pencarian secara bersamaan dalam contoh penampil PDF yang berbeda.

  • Docfd mengelola penampil PDF yang diluncurkan sepenuhnya, namun penampil ini ditutup ketika Docfd dihentikan.

  • Docfd memanggil penampil PDF melalui shell sehingga mereka tetap terbuka ketika Docfd dihentikan. Docfd malah memeriksa secara berkala apakah proses tersebut masih berjalan melalui ID proses penampil PDF, namun hal ini memerlukan penanganan fork.

  • Selain melacak apakah contoh penampil PDF yang berinteraksi dengan file masih berjalan, Docfd juga perlu mengatur penanganan pembaruan file baik melalui inotify atau melalui pemeriksaan waktu modifikasi file secara berkala.

Pengakuan

• Terima kasih banyak kepada @lunacookies dan @jthvai atas banyak diskusi dan saran UI/UX
• Demo gif dan beberapa screenshot dibuat menggunakan vhs.
• ripgrep-all digunakan sebagai referensi untuk pilihan perangkat lunak ekstraksi teks
• Marc Coquand (penulis Stitch) untuk diskusi dan inspirasi tentang fungsi penyempitan hasil
• Bagian dari sintaks pencarian disalin dari fzf
• Alur kerja pengeditan riwayat perintah terinspirasi oleh alur kerja rebase interaktif Git, misalnya git rebase -i