Uniword ships with a command-line interface built on Thor. Invoke it with the uniword executable after installing the gem.

1. Global options

All commands accept --verbose (-v) for detailed output.

2. Commands

Command Description

uniword convert INPUT OUTPUT

Convert a document between DOCX and MHTML formats

uniword info FILE

Display document statistics and structure

uniword validate FILE

Validate document structure and content

uniword verify FILE

Three-layer DOCX verification (OPC, XSD, semantic)

uniword check FILE

Run accessibility and quality checks

uniword build TEMPLATE OUTPUT

Build document from a .docx template

uniword batch PATTERN OUTPUT_DIR

Batch convert documents

uniword metadata FILE

Display or edit document metadata

uniword generate INPUT OUTPUT

Generate DOCX from structured text (YAML/Markdown)

uniword review SUBCOMMAND

Review comments and tracked changes

uniword diff compare OLD NEW

Compare two DOCX files (document level)

uniword diff package OLD NEW

Compare two DOCX files (package/ZIP level)

uniword spellcheck check FILE

Spell and grammar checking

uniword images SUBCOMMAND

Manage images in documents

uniword toc SUBCOMMAND

Generate and manage Table of Contents

uniword headers SUBCOMMAND

Manage headers and footers

uniword watermark SUBCOMMAND

Manage watermarks

uniword protect SUBCOMMAND

Manage document protection

uniword theme SUBCOMMAND

Manage document themes (list, import, apply, auto)

uniword styleset SUBCOMMAND

Manage document StyleSets (list, import, apply)

uniword resources SUBCOMMAND

Export Word resources from a local installation

uniword version

Show the installed Uniword version

3. Topics

  • convert — Format conversion

  • info — Document inspection

  • validate — Structural validation

  • verify — Three-layer verification pipeline

  • check — Quality and accessibility checks

  • build — Template building

  • batch — Batch processing

  • metadata — Document metadata

  • generate — DOCX generation from structured text

  • review — Comments and tracked changes

  • diff — Document comparison

  • spellcheck — Spell and grammar checking

  • images — Image management

  • toc — Table of Contents

  • headers — Headers and footers

  • watermark — Watermarks

  • protect — Document protection

  • theme — Theme operations

  • styleset — StyleSet operations

Table of contents