I built an offline shell-command explainer that hands you a shareable card

Описание и применение

cmdxray — локальный инструмент, который разъясняет сложные shell‑команды, генерируя автономные SVG/HTML‑карточки, пригодные для вставки в PR‑комментарии, runbooks и презентации.

Задача

Team members and incident responders often forget or misinterpret complex shell commands, and online tools like explainshell.com expose sensitive data and require network access.

Результат

cmdxray provides accurate, version‑specific explanations of shell commands locally, producing shareable cards that keep sensitive data private and integrate easily into documentation workflows.

Рабочий процесс

• 1. Install cmdxray via npx or from the repo.
• 2. Run npx cmdxray <your command> to get a plain‑text explanation.
• 3. Add --svg or --html to emit a shareable card.
• 4. Include the generated card in PR comments, runbooks, or slides.

Доказательства

It runs locally. Your commands never leave the machine.

Источник

For anything it doesn't have curated, it reads the summary from your machine's own man pages

Источник