explaingit

bgreenwell/doxx

Analysis updated 2026-07-03

3,669MakefileAudience · developerComplexity · 1/5Setup · easy

TLDR

doxx is a command-line tool that opens Microsoft Word (.docx) files in your terminal without needing Word or Office installed. It can also export documents to Markdown, CSV, or JSON.

Mindmap

mindmap
  root((repo))
    What it does
      Read docx files
      Interactive view
      Export formats
    Modes
      Interactive navigation
      Export to file
    Outputs
      Markdown
      CSV tables
      JSON
    Audience
      Developers
      Terminal users
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Open a Word document in the terminal and scroll through it with keyboard shortcuts without installing Microsoft Office.

USE CASE 2

Convert a .docx file to Markdown by exporting it for use in documentation or a static site.

USE CASE 3

Extract table data from a Word report as CSV to analyze it in a spreadsheet or data tool.

USE CASE 4

Search through a Word document for a specific phrase using the built-in search without opening a GUI app.

What is it built with?

Rust

How does it compare?

bgreenwell/doxxmanna-harbour/miryokuhttpwg/http2-spec
Stars3,6693,7003,760
LanguageMakefileMakefileMakefile
Setup difficultyeasymoderateeasy
Complexity1/53/51/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

In plain English

doxx is a command-line tool for reading Microsoft Word documents in the terminal without installing Word or any Office software. You point it at a .docx file and it renders the contents in your terminal, preserving formatting like bold, italic, tables, and lists. It is written in Rust, which makes it fast. The tool runs in two modes. The interactive mode opens a document with keyboard navigation, so you can scroll through pages, search for specific text, and jump to sections using an outline view. The export mode lets you convert the document to plain text, Markdown, CSV, JSON, or ANSI-colored terminal output by piping the result to a file or another command. The CSV export is specifically for tables: it extracts only the tabular data from the document, ignoring prose, which is useful for pulling structured data out of reports. A few features depend on the terminal you are using. Images embedded in Word documents can be displayed inline if your terminal supports it (iTerm2, Kitty, and WezTerm are mentioned). Color rendering from the original Word document can also be shown. Documents that contain mathematical equations get rendered using LaTeX formatting in the terminal. Installation is available through Homebrew on macOS and Linux, Cargo (the Rust package manager), apt on Debian and Ubuntu, pacman on Arch Linux, Nix, Conda, and Scoop on Windows. Pre-built binaries are available on the releases page for macOS (Intel and Apple Silicon), Linux, and Windows. The tool is open source and listed as a terminal tool of the week by a terminal software directory called Terminal Trove. The README includes screenshots showing how tables, colors, lists, and equations appear in practice.

Copy-paste prompts

Prompt 1
Show me the doxx command to export a Word document called report.docx to Markdown and save the output as report.md.
Prompt 2
How do I use doxx interactive mode to open a .docx file in the terminal and search for a specific keyword?
Prompt 3
Using doxx, how do I extract only the table data from a Word file and output it as CSV for import into a spreadsheet?
Prompt 4
What doxx command opens a document and shows the outline view so I can jump to specific sections quickly?

Frequently asked questions

What is doxx?

doxx is a command-line tool that opens Microsoft Word (.docx) files in your terminal without needing Word or Office installed. It can also export documents to Markdown, CSV, or JSON.

What language is doxx written in?

Mainly Makefile. The stack also includes Rust.

How hard is doxx to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is doxx for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Scan in gitsafehub Deploy in gitdeployhub bgreenwell on gitmyhub

Verify against the repo before relying on details.