Repolode
Submit
bgreenwell

bgreenwell/doxx

A terminal viewer for .docx Word files that renders formatting, tables and images, with search and export to Markdown, CSV, JSON or text.

Open-source alternative to:Microsoft Word

View on GitHubWebsite
Stars
3,777
Forks
98
Open issues
12
Last commit
2 months ago

What is it?

doxx is a command-line viewer for Microsoft Word .docx files. It renders bold, italic, headings, lists, colored text and Unicode tables in the terminal, so you can read a document without opening Word or a browser.

Beyond viewing, it supports interactive search with highlighting, an outline view for navigation, and copying content to the clipboard. Documents can also be exported as Markdown, CSV (tables only), JSON metadata, plain text, or ANSI-colored output for piping into other tools.

Inline and display LaTeX equations are rendered, and images can be shown in terminals such as Kitty, iTerm2, WezTerm and Sixel-capable terminals, or extracted to a folder. Keymaps can be switched between default, vim and less presets, and individual keys can be remapped in a TOML config file.

Key features

  • 01Renders formatted text, colors, tables and lists in the terminal.
  • 02Interactive search with highlighting and an outline view.
  • 03Export to Markdown, CSV (tables only), JSON, plain text or ANSI.
  • 04Renders inline and display LaTeX equations.
  • 05Displays images inline in Kitty, iTerm2, WezTerm and Sixel terminals.
  • 06Configurable vim and less keymap presets.

Use cases

  • Quickly reading a Word report or contract from an SSH session without Word installed.
  • Extracting tables from a .docx into CSV for analysis in Python or Excel.
  • Converting Word documents to Markdown for a documentation or static-site workflow.
  • Searching and copying sections of a long document from the command line.

Quick start

  1. 1

    Install with Homebrew (macOS/Linux)

    brew install bgreenwell/tap/doxx
  2. 2

    Or install with Cargo (cross-platform)

    cargo install doxx
  3. 3

    View a Word document in the terminal

    doxx report.docx

Things to know

  • Inline image display only works in supported terminals such as Kitty, iTerm2 and WezTerm.
  • The README lists conflicting Rust minimum versions (1.70+ and 1.88+).

Topics

#docx#terminal#cli#rust#tui#markdown#csv-export#msword#render

FAQ

What is doxx?
A terminal viewer for .docx Word files that renders formatting, tables and images, with search and export to Markdown, CSV, JSON or text. doxx is a command-line viewer for Microsoft Word .docx files. It renders bold, italic, headings, lists, colored text and Unicode tables in the terminal, so you can read a document without opening Word or a browser.
Is doxx free to use? What license does it have?
doxx is open source under the MIT license. Check the license terms before using it in commercial products.
Is doxx still maintained?
Updated within 6 months. The last commit to doxx was on Aug 10, 2026.
What can I use doxx for?
Quickly reading a Word report or contract from an SSH session without Word installed. Extracting tables from a .docx into CSV for analysis in Python or Excel. Converting Word documents to Markdown for a documentation or static-site workflow. Searching and copying sections of a long document from the command line.
How do I install doxx?
Install with Homebrew (macOS/Linux): brew install bgreenwell/tap/doxx Or install with Cargo (cross-platform): cargo install doxx View a Word document in the terminal: doxx report.docx
Where can I get doxx?
The source code and installation instructions are on GitHub: https://github.com/bgreenwell/doxx

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects