Quick Start

Choose an installation

Word documents
```
pip install "ChatWord[word]"
```
Enables .docx inspection and text extraction.
PDF documents
```
pip install "ChatWord[pdf]"
```
Enables PDF metadata inspection and text extraction.
Common document stack
```
pip install "ChatWord[all]"
```
Installs the Word, PDF, and OCR dependency foundations together.

chatword --version
chatword --tree
chatword --tree-brief

The full tree includes parameter signatures. The brief tree keeps the same commands and descriptions without signatures.

chatword inspect ./example.docx
chatword inspect ./example.pdf --json

Human-readable output is useful in a terminal. --json is intended for agents, scripts, and CI.

chatword extract ./example.docx
chatword extract ./example.pdf -o ./example.txt

Existing output files are protected by default:

chatword extract ./example.pdf -o ./example.txt --force

Even with --force, the output path cannot be the input document.

Use -i to allow a missing-path prompt and -I to disable prompting in automation:

chatword inspect -i
chatword inspect -I

pip install -e ".[dev,docs,word,pdf]"
python -m pytest -q
python -m build
mkdocs build --strict