Skip to content
forked from bgreenwell/doxx

Expose the contents of .docx files without leaving your terminal. Fast, safe, and smart — no Office required!

License

Notifications You must be signed in to change notification settings

kardongate/doxx

 
 

Repository files navigation

doxx 📄

.docx files in your terminal — no Microsoft Word required

CI License: MIT Rust

A fast, terminal-native document viewer for Word files. View, search, and export .docx documents without leaving your command line.

doxx screenshot

✨ Features

  • Beautiful terminal rendering with formatting, tables, and lists
  • Fast search with highlighting 🔍
  • Smart tables with proper alignment and Unicode borders
  • Copy to clipboard — grab content directly from the terminal
  • Export formats — Markdown, CSV, JSON, plain text
  • Terminal images for Kitty, iTerm2, WezTerm 🖼️
  • Color support — see Word document colors in your terminal

🚀 Installation

Pre-built binaries

Download from GitHub releases:

# macOS/Linux
curl -L https://github.com/bgreenwell/doxx/releases/latest/download/doxx-$(uname -s)-$(uname -m).tar.gz | tar xz
sudo mv doxx /usr/local/bin/

# Verify
doxx --version

Build from source

git clone https://github.com/bgreenwell/doxx.git
cd doxx
cargo install --path .

🎯 Usage

# View a document
doxx report.docx

# Search for content
doxx contract.docx --search "payment"

# Start with outline view
doxx document.docx --outline

# Export to different formats
doxx data.docx --export csv > data.csv
doxx report.docx --export markdown > report.md

# View with images (supported terminals)
doxx presentation.docx --images --export text

# Enable color rendering
doxx slides.docx --color

⌨️ Navigation

Key Action
/k Scroll up
/j Scroll down
o Toggle outline
s Search
c Copy to clipboard
h Help
q Quit

🔧 Why doxx?

Current terminal tools for Word documents:

  • docx2txt → Loses all formatting, mangled tables
  • pandoc → Complex chain, formatting lost
  • antiword → Only handles old .doc files

doxx gives you:

  • ✅ Rich formatting preserved (bold, italic, headers)
  • ✅ Professional table rendering with alignment
  • ✅ Interactive navigation and search
  • ✅ Multiple export formats for workflows
  • ✅ Terminal image display for modern terminals
  • ✅ Fast startup (50ms vs Word's 8+ seconds)

Perfect for developers, sysadmins, and anyone who prefers the terminal.

📊 Examples

Quick document analysis

# Get overview and search
doxx quarterly-report.docx
doxx --search "revenue"

# Extract tables for analysis
doxx financial-data.docx --export csv | python analyze.py

Copy workflows

# Review and copy sections
doxx meeting-notes.docx
# Press 'c' to copy current view to clipboard

# Copy search results
doxx specs.docx --search "requirements"
# Press F2 to copy results with context

Pipeline integration

# Extract text for processing
doxx notes.docx --export text | grep "action items"

# Get document structure
doxx report.docx --export json | jq '.metadata'

🏗️ Architecture

Built with Rust for performance:

🛠️ Development

# Build and test
cargo build --release
cargo test

# Run with sample document
cargo run -- tests/fixtures/sample.docx

📋 Roadmap

  • Enhanced table support (merged cells, complex layouts)
  • Performance improvements for large documents
  • Hyperlink navigation
  • Custom themes

📝 License

MIT License — see LICENSE file for details.


Made for developers who live in the terminal 🚀

About

Expose the contents of .docx files without leaving your terminal. Fast, safe, and smart — no Office required!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 100.0%