What it does:
* View `.docx` files directly in your terminal with (mostly) proper formatting
* Tables actually look like tables (with Unicode borders!)
* Nested lists work correctly with indentation
* Full-text search with highlighting
* Copy content straight to clipboard with `c`
* Export to markdown/CSV/JSON
Why I made this:
Working on servers over SSH, I constantly hit Word docs I needed to check quickly. The existing solutions I'm aware of either strip all formatting (docx2txt) or require GUI apps. Wanted something that felt as polished as [glow](https://github.com/charmbracelet/glow) but for Word documents.
The good stuff:
* 50ms startup vs Word's 8+ seconds
* Works over SSH (obviously)
* Preserves document structure and formatting
* Smart table alignment based on data types
* Interactive outline view for long docs
Built with Rust + ratatui and heavily inspired by Charm's [glow](https://github.com/charmbracelet/glow) package for viewing Markdown in the CLI (built in Go)!
# Install
cargo install --git https://github.com/bgreenwell/doxx
# Use
doxx quarterly-report.docx
But a humble request: please make sure that the planned "AI integration" is completely optional, not compiled-in, or, even better, a sister project ("aidoxx"?).
Having the functionality of sending the contents of a Word document to any external service will be a red flag and block adoption of this tool in many environments.
`doxx document.docs | doxxAI`
Even without any of the bad vibes around AI, it is just much more aesthetic and wonderful if the core doxx util was a single purpose command.
Also, it is open source so if it's sufficiently useful, someone will spin off a AI stripped down version anyways, and that'll probably gain more users/goodwill in the kind of CLI SSH dev niche market this tool is trying to fit in.
The name causes miscues and carries negative connotations, though, on account of its homonym verb (doxxing).
Scripting uses interest me too. Perhaps pandoc will still be a better option, but I'm also a sucker for TUIs and _Charm projects!
But still doxx feels like it would just get some unwarranted attention when its unnecessary and docc seems a nice enough name too.
I mean, the project seems fantastic but still the project seems quite new and I don't think that it would suffer anything from a name change.
I did something like this with pandoc:
Keeps a lot or formatting. My favorite way to read a README file in the terminal- https://github.com/mikeebowen/OOXML-Validator (if you plan on making edits, you'll want to ensure they're renderable by other Word users)
- https://marketplace.visualstudio.com/items?itemName=yuenm18.... (incredible VS code extension for debugging OOXML files)
One thing that will surprise a lot of users is how common old-style Word (.doc) files are still. For that you might consider integrating Antiword (https://github.com/grobian/antiword) if you can get comfortable with the licensing.
Be aware that styles play an important role in numbering that doesn't seem to be picked up here. So you'll want to apply the styles before calculating the numbering levels.
Over all really cool. Hit me up if you ever want to swap notes on Docx and Rust. My email is in my profile.
Keep it up!
Needs a new name, or a certain percentage of the audience will nope out before you even get to explain what it does.
BTW, 8 seconds to start Word? What kind of computer are you using? Word is not performance beast but its not that slow either.
Of course it's a big install on the other hand.
I tried it, but some documents are not shown correctly as far as I remember.
It's refreshing to see something that isn't another chatbot.