doc-cleaner

Category: Docs & Knowledge | Uploader: notoriouslab | Downloads: 0 | Version: v1.0（Latest）

Convert PDF, DOCX, XLSX, and text files to clean, structured Markdown. CJK-friendly, table-friendly, privacy-first.

Changelog: Source: GitHub https://github.com/notoriouslab/doc-cleaner

Directory Structure

Current level: Root

📁 ai/
- 📄 __init__.py 0 B
- 📄 base.py 3.3 KB
- 📄 gemini.py 1.9 KB
- 📄 ollama.py 3.9 KB
📁 classifiers/
- 📄 __init__.py 0 B
- 📄 noise.py 2.4 KB
- 📄 pdf_classifier.py 3.0 KB
- 📄 pii.py 3.8 KB
📁 output/
- 📄 __init__.py 0 B
- 📄 markdown.py 2.7 KB
📁 parsers/
- 📄 __init__.py 0 B
- 📄 docx.py 3.4 KB
- 📄 pdf.py 3.9 KB
- 📄 text.py 1.2 KB
- 📄 xlsx.py 2.8 KB
📁 prompts/
- 📄 __init__.py 0 B
- 📄 default.txt 835 B
- 📄 finance.txt 1.2 KB
📄 .env.example 220 B
📄 .gitignore 235 B
📄 cleaner.py 19.4 KB
📄 config.example.json 747 B
📄 CONTRIBUTING.md 2.4 KB
📄 LICENSE 1.0 KB
📄 README.en.md 11.5 KB
📄 README.md 12.4 KB
📄 requirements.txt 440 B
📄 SECURITY.md 3.4 KB
📄 SKILL.md 2.6 KB

SKILL.md

---
name: doc-cleaner
description: Convert PDF, DOCX, XLSX, and text files to clean, structured Markdown. CJK-friendly, table-friendly, privacy-first.
version: 1.0.0
metadata: {"openclaw":{"emoji":"📄","homepage":"https://github.com/notoriouslab/doc-cleaner","requires":{"bins":["python3"]}}}
---

# doc-cleaner

Convert documents (PDF, DOCX, XLSX, TXT) to clean, structured Markdown.

## When to use

- User asks to convert a document to Markdown
- User wants to extract text or tables from PDF/DOCX/XLSX files
- User wants to clean up bank statements or financial documents
- User asks to process a batch of documents in a directory

## Commands

### Convert a single file (no AI, fastest)
```bash
python3 {baseDir}/cleaner.py --input "{{file_path}}" --ai none
```

### Convert a single file with AI structuring
```bash
python3 {baseDir}/cleaner.py --input "{{file_path}}" --ai gemini
```

### Convert all files in a directory
```bash
python3 {baseDir}/cleaner.py --input "{{directory}}" --ai none --output-dir "{{output_dir}}"
```

### Preview without writing (dry run)
```bash
python3 {baseDir}/cleaner.py --input "{{file_path}}" --dry-run --verbose
```

### Get machine-readable result summary
```bash
python3 {baseDir}/cleaner.py --input "{{file_path}}" --ai none --summary
```

The `--summary` flag prints a JSON summary to stdout after processing:
```json
{"version":"1.0.0","total":3,"success":2,"failed":1,"files":[{"file":"report.pdf","output":"./output/report.md","status":"ok"},{"file":"scan.pdf","output":null,"status":"no_content"},{"file":"data.xlsx","output":"./output/data.md","status":"ok"}]}
```

## Options

| Flag | Description |
|---|---|
| `--input, -i` | File or directory to process (required, non-recursive) |
| `--output-dir, -o` | Output directory (default: ./output) |
| `--ai` | `gemini`, `ollama`, or `none` (default: from config or gemini) |
| `--password` | PDF decryption password |
| `--config` | Path to config JSON |
| `--summary` | Print JSON summary to stdout after processing |
| `--dry-run` | Preview without writing files |
| `--verbose` | Enable debug logging |

## Supported formats

PDF (native, scanned, encrypted), DOCX, XLSX, XLS, CSV, TXT, MD

## Exit codes

| Code | Meaning |
|---|---|
| 0 | All files processed successfully |
| 1 | Some files failed (partial success) |
| 2 | No processable files found or config error |

## Notes

- Output defaults to `./output/` relative to current directory
- For scanned PDFs, AI mode (`gemini` or `ollama`) gives much better results
- `--ai none` requires zero API keys and zero network access
- CJK encoding (Big5, CP950, UTF-16) is auto-detected
- Tables in DOCX and XLSX are preserved as Markdown pipe tables

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

doc-cleaner

Directory Structure

SKILL.md

Report

Notice