Utilities for working with Red Hat documentation. Setup, full CLI reference, output layout, and behavior are documented in RH-Doc-Downloads/README.md.
Install dependencies from the repository root (uv sync, or python3 -m venv .venv plus pip install -r requirements.txt). Then run the downloader from RH-Doc-Downloads/ (see that README for uv run vs an activated venv).
Download OpenShift Container Platform 4.21 as Markdown with per-guide PDFs under ocp/:
cd RH-Doc-Downloads
python rh_docs_downloader.py --product openshift_container_platform --version 4.21 --pdf --output ocp/While each book is processed you may see a tqdm-style progress line similar to:
Books: 61%|████████████████████████████████████████████████████████▌ | 70/115 [13:21<08:35, 11.46s/it]
To find product names, use the --list-products parameter. Narrow the product list with a case-insensitive substring on product slug, version, or title:
python rh_docs_downloader.py --list-products --list-filter aiExample output:
9 of 104 product(s) match --list-filter 'ai' (substring, case-insensitive).
PRODUCT (--product) VERSION (--version) DOCUMENTATION TITLE
-------------------------------------------------------- ------------------- -------------------------------------------
red_hat_advanced_developer_suite_-_software_supply_chain 1.9 Red Hat Advanced Developer Suite
red_hat_ai 3 Red Hat AI
red_hat_ai_enterprise 3 Red Hat AI Enterprise
red_hat_ai_inference_server 3.4 Red Hat AI Inference Server
red_hat_enterprise_linux_ai 3.4 Red Hat Enterprise Linux AI
openshift_container_platform 4.21 Migration Toolkit for Containers
red_hat_openshift_ai_self-managed 3.4 Red Hat OpenShift AI
openshift_sandboxed_containers 1.12 Red Hat OpenShift sandboxed containers
workload_availability_for_red_hat_openshift 26.2 Workload Availability for Red Hat OpenShift
More options and how --list-products splits stderr and stdout are described in RH-Doc-Downloads/README.md.