Overview

revise is a command-line tool and TypeScript library for Word documents. It reads a .docx as HTML with stable block ids, edits it with the same tools the Revise agent uses, records edits as tracked changes, and writes the file back. Untouched content is written back byte for byte.

It is built for AI agents and the programs that run them: every command has --json output, edits are undoable, and the editing tools come with schemas a model can call.

Install

npm i -g revise

Quick install for AI Agents (skill included):

npx -y revise@latest skill install

Node 20 or newer. No account, API key, or telemetry, and documents never leave your machine. Two things fetch over the network: PDF export downloads its fonts from revise.io, and an image you insert by URL is downloaded.

What it does#

• Read documents as HTML with block ids, an outline with block ranges, or plain-text search results.
• Edit with tracked changes by default in .docx: replace text, insert and replace blocks, tables, comments, footnotes, styles, headers and footers, page layout.
• Review pending changes by id or by section, see a word-level diff, accept or reject, and undo.
• Write .docx, PDF, Markdown, HTML, and text; render pages as images; compare two versions into a redline; create a document from Markdown or HTML.
• Collaborate: seed a sync server's room from a file, and edit or export a live Yjs document that browsers are editing.

Pick an entry point#