Skip to content

hansdoebel/docling-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docling-tui

A terminal user interface for Docling document conversion, built with Ratatui.

Features

  • Interactive wizard for configuring Docling conversions
  • Built-in file explorer for selecting source documents (PDF, DOCX, PPTX, HTML, images, and more)
  • Directory browser for choosing output destinations
  • Live streaming of conversion output
  • Vim-style keyboard navigation

Keybindings

Source Input

Key Action
Tab / Ctrl+B / Ctrl+F Open file explorer
Enter Confirm path or URL
Esc Go back

File Explorer (overlay)

Key Action
j / k / arrows Navigate files
Enter / l Select file or enter directory
Backspace / h Go to parent directory
/ Search
s Cycle sort mode
. Toggle hidden files
Esc / q Dismiss

Conversion Config

Key Action
j / k Navigate fields
Space / h / l Change field value
Tab (on Output Dir) Browse for directory
Enter Start conversion (or edit Output Dir)
Esc Go back

Directory Browser (overlay)

Key Action
Navigate as file explorer
o Select current directory
Esc / q Dismiss

Installation

See docs/installation.md.

Reference

Docling CLI Reference: https://docling-project.github.io/docling/reference/cli/

Ratatui: https://github.com/ratatui/ratatui

tui-file-explorer: https://github.com/sorinirimies/tui-file-explorer

About

A terminal user interface for Docling

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors