Skip to content

URL and Web CLI Reference

Command: md-url

Arguments

Name Type Required Default Choices Description
url str required — — Single HTTP or HTTPS URL
output Path required — — Output .md file or directory (with --artifact-layout); omit when using --urls-file with -o
-o Path optional None — Output directory for --urls-file (bulk) mode
--urls-file Path optional None — Text file with one URL per line
--artifact-layout flag optional false — Write document.md + assets/ under output dir
--crawl flag optional false — Breadth-first crawl (requires --artifact-layout)
--async-crawl flag optional false — Use async HTTP + parallel page fetches (requires --crawl); default is sync crawl
--crawl-max-concurrency int optional 4 — Max concurrent page fetches when --async-crawl (default: 4, max: 32)
--max-depth int optional 2 — —
--max-pages int optional 30 — —
--crawl-delay float optional 0.5 — Seconds between crawl requests
--no-robots flag optional false — Do not consult robots.txt
--no-subdomains flag optional false — Only exact same host when following links
--images-dir Path optional None — Classic mode: image directory (default: /images)
--timeout float optional 30.0 — —
--max-response-mb float optional 10.0 — —
--no-table-csv flag optional false — —
--no-linked-files flag optional false — Skip downloading linked PDF/ZIP/etc.
--max-linked-files int optional 40 — Max linked file downloads per page (default: 40)
--max-downloaded-images int optional 50 — Max image downloads per page (default: 50)
--no-convert-downloaded-assets flag optional false — Do not run internal converters on files under assets/files/
--no-convert-downloaded-images flag optional false — Skip OCR for raster images under assets/images/ (default: run when mdengine[image] is installed)
--convert-downloaded-image-to-md-engines str optional DEFAULT_IMAGE_TO_MD_ENGINES — Comma-separated OCR engines for downloaded images: tess, paddle, easy (default: %(default)s)
--convert-downloaded-image-to-md-strategy str optional 'best' ('best', 'compare') How to combine engine outputs for downloaded images (default: "best")
--convert-downloaded-image-to-md-title str optional '' — Markdown title inside the bundled OCR file (default: empty → "Downloaded images (OCR)")
--post-convert-pdf-ocr flag optional false — When converting downloaded PDFs, enable page OCR like md-pdf --ocr
--no-post-convert-ppt-embedded flag optional false — When converting downloaded PPTX, disable deep embedded extraction
-v flag optional false — —

Exit codes

Code Meaning
0 Success
1 Runtime conversion failure
2 Invalid usage or missing input