Terminal Command Formatter

Examples

❌ WRONG:

# Install HACS
wget -O - https://get.hacs.xyz | bash -

# Restart Home Assistant
ha core restart  # This will take a minute

✅ RIGHT:

Install HACS:

wget -O - https://get.hacs.xyz | bash -

Restart Home Assistant (this will take about a minute):

ha core restart

Code File Exceptions

When creating saved files (not direct terminal commands), comments ARE appropriate:

Shell script file (saved as script.sh):

#!/bin/bash
# This script backs up Home Assistant
# Usage: ./backup-ha.sh

BACKUP_DIR="/backup"
DATE=$(date +%Y%m%d)

# Create backup
ha backups new --name "backup-${DATE}"

Summary

• Terminal command blocks: NO comments, explain in prose
• Saved script files: Comments OK with proper syntax
• Multi-step processes: Separate blocks with prose between
• Copy/paste safety: Top priority for terminal commands