Skip to content

CLI Reference

mkuch edited this page Jul 13, 2026 · 2 revisions

CLI Reference

Only input and output paths are required for a single export:

rayomd --export input.md output.pdf

Commands

rayomd --version
rayomd --export input.md output.pdf native elegant normal
rayomd --stdin output.pdf native elegant normal
rayomd --batch input-folder output-folder native modern normal
rayomd --stdin-batch output-folder native modern normal
rayomd --serve output-folder native modern normal
rayomd --bench input.md bench-output-folder 5000 modern normal
Mode Use case
--version Print the compiled project version
--export Convert one Markdown file
--stdin Read Markdown from stdin and create one PDF
--batch Convert every .md file in a folder
--stdin-batch Read Markdown file paths from stdin
--serve Keep one process warm and read paths from stdin
--bench Measure native PDF generation time and output size

Styles are elegant, modern, and tech. Margins are compact, normal, wide, margin=0.75in, or margin=54pt.

Images and trust boundaries

Local images are contained to the input file's directory by default. URL images are disabled unless --allow-url-images is passed. Stdin has no input-file directory, so relative images fall back to alt text unless --allow-unsafe-local-images is explicitly used for trusted input.

Exit codes

Code Meaning
0 Success
2 Missing or invalid arguments
3 Input file or stdin could not be read
11 Native exporter could not load a system font
12 Native exporter could not write the PDF
20 Pandoc export failed or is unsupported in this build

Clone this wiki locally