Oma Hwp

HWP Skill - HWP / HWPX / HWPML to Markdown Conversion

Scheduling

Goal

Convert Korean HWP-family documents into readable Markdown or structured JSON while preserving document structure for LLM context, RAG, government-document review, or enterprise document processing.

Intent signature

• User asks to convert, parse, read, extract, or transform .hwp, .hwpx, or .hwpml.
• User mentions Korean word processor files, Hangul documents, government forms, or "한글 파일".
• User needs headings, tables, nested tables, lists, images, footnotes, or hyperlinks extracted from HWP-family files.

When to use

• Converting Korean HWP documents (.hwp, .hwpx, .hwpml) to Markdown
• Preparing Korean government/enterprise documents for LLM context or RAG
• Extracting structured content (tables, headings, lists, images) from HWP
• User says "convert this HWP", "parse hwpx", "HWP to markdown", "한글 파일"

When NOT to use

• PDF files -> use oma-pdf (OCR + Tagged PDF specialization)
• XLSX / DOCX files -> out of scope; run bunx kordoc directly if needed (note: oma-docs is the documentation-drift skill, not a converter)
• Generating or editing HWP documents -> out of scope (kordoc itself supports generate / fill / seal / patch / redact / lint / validate / render subcommands; run bunx kordoc@latest <subcommand> directly if needed)
• Already-text files -> use Read tool directly

Expected inputs

• input_path: .hwp, .hwpx, or .hwpml file path
• output_path or output_dir: optional explicit output target
• format: optional output format — markdown (default), json (structured AST), or chunks (RAG-oriented structural chunk JSON with heading breadcrumbs and standalone table chunks)
• page_range: optional page or section range
• kordoc_version: optional pinned kordoc version

Expected outputs

• Markdown output next to the input file or in the requested directory
• Optional JSON or RAG-chunks output when requested
• Post-processed Markdown with flattened GFM tables and stripped Private Use Area glyphs by default
• A short report with output path, detected source format, and conversion issues

Dependencies

• bun and bunx
• bunx kordoc@latest or configured pinned kordoc version
• resources/flatten-tables.ts for Markdown cleanup
• Local filesystem access to input and output paths

Control-flow features

• Branches by file extension, output target, format, page range, encryption/DRM state, and post-processing requirements
• Calls external CLI tools through bunx and bun run
• Reads local HWP-family files and writes local Markdown or JSON output
• Routes non-HWP inputs to other skills instead of stretching this skill's scope

Structural Flow

Entry

1. Confirm the input path exists.
2. Confirm the extension is .hwp, .hwpx, or .hwpml.
3. Resolve output path or directory and default filename.
4. Check that bun is available.

Scenes

1. PREPARE: Validate path, extension, size, output target, and requested format.
2. ACQUIRE: Detect source format and runtime availability.
3. ACT: Run kordoc with explicit output target and requested options.
4. VERIFY: Post-process Markdown and inspect structure for headings, tables, lists, images, and footnotes.
5. FINALIZE: Report output path, source format, and any conversion limitations.

Transitions

• If the input is .pdf, stop and route to oma-pdf.
• If the input is .xlsx or .docx, explain that this skill does not advertise those formats.
• If bun is unavailable, stop and ask the user to install Bun.
• If Markdown is produced, run resources/flatten-tables.ts unless the caller explicitly needs HTML tables or PUA glyphs preserved.
• If output is empty or garbled, consult resources/troubleshooting.md.

Failure and recovery

Exit

• Success: output file exists and structure is readable after post-processing.
• Partial success: output exists with explicitly reported table, glyph, encryption, or fidelity limitations.
• Failure: no reliable output is produced and the blocking cause is reported.

Logical Operations

Actions

Tools and instruments

• kordoc: primary HWP-family conversion CLI
• flatten-tables.ts: post-processing for GFM tables and Hancom PUA cleanup
• bun / bunx: runtime and CLI executor

Canonical command path

bunx kordoc@latest "{input_path}" -o "{output_path}"
# fresh clone: run `bun install` in {skill_dir}/resources/ first (node_modules is gitignored)
bun "{skill_dir}/resources/flatten-tables.ts" "{output_path}"
# {skill_dir} = this skill's directory: .agents/skills/oma-hwp (project mode) or ~/.agents/skills/oma-hwp (global mode)

For batch conversion, use an explicit output directory:

bunx kordoc@latest "{input_pattern}" -d "{output_dir}"

Resource scope

Preconditions

• Input file exists and is readable.
• Output location is writable or can be created.
• bun is installed.
• kordoc can parse the document or fail with a reportable error.

Effects and side effects

• Creates Markdown or JSON output files.
• May flatten merged-cell tables, trading cell fidelity for Markdown compatibility.
• Strips Private Use Area characters by default because they render as blanks without Hancom fonts.
• Does not intentionally modify the source HWP-family document.

Guardrails

1. Always pass @latest or an explicit pinned version to avoid stale bunx cache.
2. Always pass an explicit output target when the user expects a file.
3. Do not add custom security defenses around kordoc's ZIP, XML, SSRF, or XSS defenses.
4. Report missing tables, garbled text, empty output, encrypted segments, and best-effort DRM extraction.
5. Keep full CLI details in resources/execution-protocol.md and troubleshooting branches in resources/troubleshooting.md.

Supported Formats

kordoc also parses PDF / XLSX / DOCX and offers document-authoring subcommands (generate, fill, seal, patch, redact, lint, validate, render). All of those are intentionally outside this skill's scope; see "When NOT to use". Conversion-quality flags (--dedupe-headers, --keep-empty-cols, --inline-images) and the chunks format are documented in resources/execution-protocol.md.

References

• Execution protocol: resources/execution-protocol.md
• Troubleshooting: resources/troubleshooting.md
• Configuration: read the hwp: section of .agents/oma-config.yaml first, then fall back to config/hwp-config.yaml for any key it does not set (supported_formats lives only in the skill config). User overrides belong in .agents/oma-config.yaml, since oma update overwrites the skill config.
• Upstream: https://github.com/chrisryugj/kordoc
• Related: ../oma-pdf/SKILL.md (use for .pdf inputs)