The Unix Philosophy Meets Markdown: Building Beautiful Dashboards from CLI Output
Learn how to transform raw terminal output into polished markdown dashboards using the Unix pipe. Perfect for DevOps engineers, sysadmins, and CLI power users who want beautiful reports without leaving the command line.
The Unix Philosophy Meets Markdown: Building Beautiful Dashboards from CLI Output
Every seasoned DevOps engineer knows the power of the Unix pipe. That simple | character chains commands together, transforming raw data into exactly what you need. But what if you could pipe your terminal output directly into a beautifully rendered markdown document?
Enter the ohaimarkdown CLI tool. It bridges the gap between your terminal workflow and visual presentation, turning any command output into polished, readable markdown instantly. No files created. No clutter. Just beautiful output that appears when you need it and disappears when you are done.
Why Pipe Terminal Output to Markdown?
As a DevOps engineer or sysadmin, you spend hours in the terminal. Git logs, system monitoring, file listings, process management -- it is all text-based. While functional, raw terminal output can be hard to scan, especially when you need to share information with teammates or create quick reports.
Markdown rendering transforms that raw output into:
- Formatted tables that are easy to read
- Bulleted lists that organize information clearly
- Code blocks with proper formatting
- Headers and emphasis that guide the eye
The Unix philosophy of "do one thing well" extends perfectly here: your existing commands do their job, and the pipe sends their output to a renderer that does its job.
Getting Started: Installation
Setting up the ohaimarkdown CLI takes seconds:
- Open Ohai Markdown Reader
- Go to Settings (Cmd+,)
- Click Command Line Tool
- Follow the installation prompt
Verify your installation with the classic hello world:
echo "# Hello World\n\nThis is **bold** and this is *italic*." | ohaimarkdown
A window appears with your rendered markdown. Close it, and it is gone. No file saved to disk.
Practical Shell Command Examples
Let us explore real-world scenarios where piping to markdown transforms your workflow.
Git Workflow Dashboards
Git logs are notoriously dense. Transform them into readable lists:
echo "# Recent Commits\n\n$(git log --oneline -10 | sed 's/^/- /')" | ohaimarkdown
Need more detail? Create a commit table with author information:
echo "# Last 5 Commits\n\n| Hash | Author | Message |\n|------|--------|---------|\n$(git log --pretty=format:'| %h | %an | %s |' -5)" | ohaimarkdown
Check branch status at a glance:
echo "# Branches\n\n$(git branch -a | sed 's/^/- /')" | ohaimarkdown
Or wrap your git status in a code block for clear formatting:
echo "# Git Status\n\n\`\`\`\n$(git status -s)\n\`\`\`" | ohaimarkdown
System Information Dashboards
Build instant system dashboards by combining multiple commands:
echo "# System Info\n\n**User:** $(whoami)\n**Date:** $(date)\n**Host:** $(hostname)" | ohaimarkdown
Monitor disk usage with properly formatted output:
echo "# Disk Usage\n\n\`\`\`\n$(df -h | head -5)\n\`\`\`" | ohaimarkdown
Create a process monitoring table showing top CPU consumers:
echo "# Top Processes\n\n| PID | CPU | Command |\n|-----|-----|---------|\n$(ps aux | sort -nrk 3 | head -5 | awk '{print "| " $2 " | " $3 "% | " $11 " |"}')" | ohaimarkdown
Directory Listings as Tables
Transform ls output into clean, scannable tables:
echo "# Current Directory\n\n| Name | Size |\n|------|------|\n$(ls -lh | tail -n +2 | awk '{print "| " $9 " | " $5 " |"}')" | ohaimarkdown
Network and API Debugging
Debug network issues with formatted output:
echo "# Network\n\n**Local IP:** $(ipconfig getifaddr en0 2>/dev/null || echo 'N/A')\n**Public IP:** $(curl -s ifconfig.me)" | ohaimarkdown
Inspect HTTP response headers:
echo "# Response Headers\n\n\`\`\`\n$(curl -sI https://example.com | head -10)\n\`\`\`" | ohaimarkdown
Development Workflow Integration
Find and display TODO comments across your codebase:
echo "# TODOs Found\n\n$(grep -r "TODO" --include="*.swift" . 2>/dev/null | sed 's/^/- /' | head -20)" | ohaimarkdown
Analyze your project's file composition:
echo "# File Types\n\n| Extension | Count |\n|-----------|-------|\n$(find . -type f | sed 's/.*\.//' | sort | uniq -c | sort -rn | head -10 | awk '{print "| ." $2 " | " $1 " |"}')" | ohaimarkdown
Building Full Reports
Chain multiple commands for comprehensive reports:
echo "# System Report\n\n## User\n$(whoami)\n\n## Date\n$(date)\n\n## Uptime\n$(uptime)\n\n## Memory\n\`\`\`\n$(vm_stat | head -5)\n\`\`\`" | ohaimarkdown
Or create a project overview dashboard:
echo "# Project Overview\n\n## Files\n$(ls -1 | wc -l) files in directory\n\n## Git\n$(git log --oneline -3 | sed 's/^/- /')\n\n## Size\n$(du -sh .)" | ohaimarkdown
Pro Tips for CLI Power Users
- Use
\nfor newlines in yourechostatements to structure content - Wrap code output in triple backticks for syntax highlighting and monospace formatting
- Combine commands with
$()subshells to build complex dashboards - Pipe any text-outputting command -- if it prints to stdout, it works
- Remember: ephemeral by design -- close the window and the content is gone, keeping your system clean
The Unix Philosophy in Action
This workflow embodies what made Unix great: small, focused tools that combine to accomplish complex tasks. Your existing shell commands remain unchanged. The pipe character does what it always does. And the markdown renderer adds a visual layer without disrupting your terminal-first workflow.
No context switching to a GUI. No creating temporary files. No cluttering your filesystem. Just instant, beautiful output when you need it.
Try It Today
Ready to transform your terminal workflow? Download Ohai Markdown Reader and install the CLI tool. Within minutes, you will be piping git logs, system stats, and custom dashboards into beautifully rendered markdown.
Your terminal output deserves better than raw text. Give it the formatting it deserves while staying true to the Unix philosophy that made the command line great.
Ohai Markdown Reader is available for macOS. The CLI pipe integration works with any command that outputs text to stdout.