kathairo/README.md

A CLI utility for processing USFM.

# Kathairo
*Cleansing markup from USFM files.*

Kathairo is a CLI utility for extracting plain text from USFM files.

Assuming you have `node` and `npm` installed, run:

```bash
npm install -g kathairo
```

After installation use:

```bash
kathairo --help
```

## Notes

- Currently, input files are validated with `usfm-grammar`. Invalid files are skipped.
- If no `-o` parameter is provided, `kathairo` writes to stdout.

## Developers 

To test locally, run the following command in the repository root:

```bash
./index.js -s testData/zhsOCC22/1CH.usfm -a OCCB -l cmn 
```

Then, view `output.txt`.