chm-help-to-md

Parse Compiled HTML Help files (.chm) to markdown or text. Powered by LlamaParse v2. Zero dependencies, Node 18+.

Install

npm install chm-help-to-md

Quick Start

Set your API key:

export LLAMA_CLOUD_API_KEY=llx-...

Parse a chm file:

import { parse } from "chm-help-to-md";

const result = await parse("./document.chm");
console.log(result.markdown);

Advanced Usage

import { CHMParser } from "chm-help-to-md";

const parser = new CHMParser({ apiKey: "llx-..." });

// Parse a chm file with options
const result = await parser.parse("./report.chm", {
  tier: "agentic",
  processing_options: { language: "en" },
});

// Parse a buffer (e.g. from an upload)
const buffer = fs.readFileSync("./file.chm");
const result2 = await parser.parse(buffer, {
  fileName: "file.chm",
});

API

parse(input, options?)

Uploads a document, waits for parsing to complete, and returns the result.

Input: file path (string) or file contents (Buffer | Uint8Array)

Returns: ParseResult

interface ParseResult {
  markdown: string;     // Full markdown output
  text: string;         // Full text output
  job: JobResponse;     // Job metadata (id, status, etc.)
  _raw: object;         // Raw API response
}

new CHMParser(config?)

Create an instance with explicit configuration.

| Option | Type | Default | Description | |--------|------|---------|-------------| | apiKey | string | LLAMA_CLOUD_API_KEY | API key | | baseUrl | string | https://api.cloud.llamaindex.ai | API base URL |

License

MIT