docfd

เอกสาร

TUI โปรแกรมค้นหาเอกสารคลุมเครือหลายบรรทัด

ลองนึกถึง grep แบบโต้ตอบสำหรับไฟล์ข้อความ, PDF, DOCX ฯลฯ แต่ใช้คำ/โทเค็นแทนการใช้ regex และบรรทัด เพื่อให้คุณสามารถค้นหาข้ามบรรทัดได้อย่างง่ายดาย

Docfd มุ่งหวังที่จะมอบ UX ที่ดีผ่านการผสานรวมกับโปรแกรมแก้ไขข้อความทั่วไปและโปรแกรมดู PDF ดังนั้นคุณจึงสามารถข้ามไปยังผลการค้นหาได้โดยตรงด้วยการกดปุ่มเพียงครั้งเดียว

---

คุณสมบัติ

• การจัดทำดัชนีและการค้นหาแบบมัลติเธรด

• การค้นหาไฟล์หลายไฟล์แบบคลุมเครือหลายบรรทัด

• บานหน้าต่างมุมมองเนื้อหาที่แสดงตัวอย่างข้อมูลรอบๆ ผลการค้นหาที่เลือก

• บูรณาการโปรแกรมแก้ไขข้อความและโปรแกรมดู PDF

• ประวัติคำสั่งที่แก้ไขได้ - เขียนใหม่/วางแผนการกระทำของคุณในโปรแกรมแก้ไขข้อความ

• การจำกัดขอบเขตการค้นหา - จำกัดขอบเขตการค้นหาครั้งถัดไปโดยอิงตามผลการค้นหาปัจจุบัน

• การรวมคลิปบอร์ด

การติดตั้ง

ไบนารีที่เชื่อมโยงแบบคงที่สำหรับ Linux และ macOS มีให้ใช้งานผ่าน GitHub รุ่นต่างๆ

Docfd ยังได้รับการบรรจุบนแพลตฟอร์มต่อไปนี้สำหรับ Linux:

• โอแพม
• AUR (เป็น docfd-bin ) โดย kseistrup
• ห้าม (as docfd ) โดย Chewblacka

วิธีเดียวที่จะใช้ Docfd บน Windows ได้ในขณะนี้คือผ่าน WSL

หมายเหตุสำหรับผู้ทำแพ็กเกจ : ภายนอก Toolchain OCaml สำหรับการสร้าง (หากคุณทำแพ็กเกจจากแหล่งที่มา) Docfd ยังต้องการเครื่องมือภายนอกต่อไปนี้ ณ รันไทม์เพื่อให้ฟังก์ชันการทำงานเต็มรูปแบบ:

• pdftotext จาก poppler-utils เพื่อรองรับ PDF
• pandoc สำหรับรองรับไฟล์ .epub , .odt , .docx , .fb2 , .ipynb , .html และ .htm
• fzf สำหรับเมนูการเลือกไฟล์
• wl-clibpard สำหรับการสนับสนุนคลิปบอร์ดบน Wayland
• xclip สำหรับรองรับคลิปบอร์ดบน X11

การใช้งานขั้นพื้นฐาน

การใช้งานโดยทั่วไปของ Docfd คือการใส่ cd ลงในไดเร็กทอรีที่สนใจและเปิด docfd โดยตรง หรือระบุพาธเป็นอาร์กิวเมนต์:

 docfd [PATH]...

รายการพาธสามารถมีไดเร็กทอรีได้ แต่ละไดเร็กทอรีในรายการจะถูกสแกนซ้ำสำหรับไฟล์ที่มีนามสกุลต่อไปนี้ตามค่าเริ่มต้น:

• สำหรับโหมดการค้นหาหลายบรรทัด:
  • .txt , .md , .pdf , .epub , .odt , .docx , .fb2 , .ipynb , .html , .htm
• สำหรับโหมดการค้นหาบรรทัดเดียว:
  • .log , .csv , .tsv

คุณสามารถเปลี่ยนนามสกุลไฟล์ที่จะใช้ผ่าน --exts และ --single-line-exts หรือเพิ่มลงในรายการส่วนขยายผ่าน --add-exts และ --single-line-add-exts

หากรายการ PATH ว่างเปล่า ดังนั้น Docfd จะใช้ค่าเริ่มต้นในการสแกนไดเรกทอรี . เว้นแต่จะใช้อย่างใดอย่างหนึ่งต่อไปนี้: --paths-from , --glob , --single-line-glob

เอกสารประกอบ

ดู GitHub Wiki สำหรับตัวอย่างเพิ่มเติม/ตำราอาหาร และรายละเอียดทางเทคนิค

ข้อจำกัด

• ไฟล์ PDF ไม่รองรับการโหลดไฟล์ซ้ำอัตโนมัติ เนื่องจากโปรแกรมดู PDF จะถูกเรียกใช้ในพื้นหลังผ่านเชลล์ เป็นไปได้ที่จะสนับสนุนสิ่งนี้อย่างเหมาะสมตามวิธีที่ระบุไว้ด้านล่าง แต่ต้องใช้วิศวกรรมจำนวนมากเพื่อให้ได้ประโยชน์เพียงเล็กน้อย:

  • Docfd รอให้โปรแกรมดู PDF ยุติการทำงานโดยสมบูรณ์ก่อนที่จะกลับมาทำงานต่อ แต่จะห้ามไม่ให้ดูผลการค้นหาหลายรายการพร้อมกันในโปรแกรมดู PDF ที่แตกต่างกัน

  • Docfd จัดการโปรแกรมดู PDF ที่เปิดใช้งานอย่างสมบูรณ์ แต่โปรแกรมดูเหล่านี้จะถูกปิดเมื่อ Docfd ยุติ

  • Docfd เรียกใช้โปรแกรมดู PDF ผ่านเชลล์ เพื่อให้เปิดอยู่เมื่อ Docfd ยุติ Docfd จะตรวจสอบเป็นระยะๆ แทนว่ายังคงทำงานผ่านรหัสกระบวนการของผู้ดู PDF หรือไม่ แต่สิ่งนี้จำเป็นต้องมีการจัดการทางแยก

  • นอกเหนือจากการติดตามว่าอินสแตนซ์ของโปรแกรมดู PDF ที่โต้ตอบกับไฟล์ยังคงทำงานอยู่หรือไม่ Docfd ยังต้องตั้งค่าการจัดการการอัปเดตไฟล์ผ่านทาง inotify หรือผ่านการตรวจสอบเวลาแก้ไขไฟล์เป็นระยะ

รับทราบ

• ขอขอบคุณ @lunacookies และ @jthvai เป็นอย่างยิ่งสำหรับการสนทนาและข้อเสนอแนะเกี่ยวกับ UI/UX มากมาย
• GIF สาธิตและภาพหน้าจอบางภาพสร้างขึ้นโดยใช้ vhs
• ripgrep-all ถูกใช้เป็นข้อมูลอ้างอิงสำหรับตัวเลือกซอฟต์แวร์แยกข้อความ
• Marc Coquand (ผู้เขียน Stitch) สำหรับการอภิปรายและแรงบันดาลใจของผลลัพธ์ที่จำกัดฟังก์ชันการทำงาน
• ไวยากรณ์การค้นหาบางส่วนถูกคัดลอกมาจาก fzf
• เวิร์กโฟลว์การแก้ไขประวัติคำสั่งได้รับแรงบันดาลใจจากเวิร์กโฟลว์ Rebase แบบโต้ตอบของ Git เช่น git rebase -i