chrisryugj/kordoc:README 來源編輯指南
根據 README、倉庫資料與授權整理 chrisryugj/kordoc 的安裝與核驗路徑。
專案定位
chrisryugj/kordoc 的 README 將專案描述為「모두 파싱해버리겠다 , HWP·HWPX·PDF·Office 문서를 Markdown으로. 양식 자동 채우기와 신구대조를 갖춘 CLI·MCP 서버 | Convert Korean documents (HWP, HWPX, PDF, Office) to Markdown , CLI and MCP server with form filling and diff」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「kordoc」下寫到:HWP 3.x/5.x, HWPX, HWPML, PDF, XLS, XLSX, DOCX, 이미지(PNG/JPG/WebP) , 관공서에서 쏟아지는 모든 문서를 파싱하고, 비교하고, 분석하고, 생성합니다.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「💡 kordoc으로 무엇을 할 수 있나요?」與相關條目,可以先判斷它是否處理你的實際問題:📊 복잡한 표(Table) 복원 , 숫자로 잠금: 병합·중첩 표를 구조 그대로 살립니다. HWPX 코퍼스 291문서 표 1,673/1,673·셀 27,714/27,714 무손실(독립 추출기 대조 게이트 1.0), 동일문서 hwpx↔pdf 대조(6쌍 69표)는 매칭 98.6%·완전일치 65.2%. 선 없는 PDF 표도 감지해 복원하고, 법령 개정안 PDF의 신구조문대비표도 통째로 살립니다 (v3.16.2).。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:📄 어떤 문서든 마크다운으로: HWP3 (구버전), HWP(5.x), HWPX, HWPML, PDF, XLS, XLSX, DOCX 파일은 물론 PNG/JPG/WebP 이미지(자동 OCR)까지 즉시 Markdown으로 변환합니다. AI(LLM)가 문서를 읽고 분석하기 가장 좋은 상태로 만들어줍니다.。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「⚡ 30초 설치 (AI 에이전트 연동)」等段落。可確認的線索包括:대화형 마법사가: 1. 사용 중인 AI 클라이언트 번호 선택 (Claude Desktop / Cursor / Claude Code / Windsurf / VS Code / Gemini CLI / Zed / Antigravity / Codex , 설치된 건 [감지됨] 표시) 2. 설정 파일 자동 패치 → 클라이언트 재시작。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: npm install kordoc 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「⚡ 30초 설치 (AI 에이전트 연동)」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「⚡ 30초 설치 (AI 에이전트 연동)」段落提到:Windows 도 자동으로 cmd /c npx 래핑. 수동 JSON 편집 불필요. 재시작하면 15개 문서 도구 (parsedocument, parsetable, fillform, patchdocument, generatedocument 등) 활성화.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:🔍 신구대조표 자동 생성: 두 문서의 차이점을 분석하여 무엇이 바뀌었는지 한눈에 보여줍니다. (HWP와 HWPX 간의 비교도 가능!)。