Overview

Bash-script-helper is an expert assistant for writing and debugging Bash scripts, promoting best practices that boost reliability and maintainability. It emphasizes strict mode, modern syntax, safe input handling, and clear debugging to reduce errors and simplify maintenance.

How This Skill Works

It provides a practical checklist of Bash conventions and tooling; you reference it during scripting or review. It enforces rules such as a proper shebang, set -e and -u, [[ ]] tests, quoting, and $(...) substitutions, trap-based cleanup, getopts parsing, and safe I/O with mktemp and input validation, supported by shellcheck.

When to Use It

• Starting a new Bash script and enforcing strict error handling and input validation
• Debugging a script that exits with errors or unexpected behavior to inspect exit codes and traps
• Auditing existing scripts for consistency with modern Bash practices (tests, quoting, functions)
• Implementing command-line options and parameter parsing with getopts
• Handling temporary files securely with mktemp and proper cleanup

Quick Start

1. Step 1: Create a new Bash script with #!/bin/bash and strict mode (set -e -u)
2. Step 2: Add getopts parsing and validate inputs
3. Step 3: Implement core logic with functions and enable shellcheck during development

Best Practices

• Strict mode with clear errors: #!/bin/bash, set -e, set -u, and meaningful messages
• Modern syntax: use [[ ]] tests, quoting variables, and $(...) for command substitution
• Error handling and cleanup: check exit codes, use trap, and consider enabling set -x for debugging
• Input and options: validate inputs and use getopts for robust parameter parsing
• Safe I/O and maintainability: read files line by line, use functions/arrays, avoid eval, shellcheck, mktemp, and proper permissions

Example Use Cases

• Skeleton of a new script with strict mode and a basic getopts block
• Script that reads a log file line by line and processes each entry safely
• Utility with command-line options like verbose and help using getopts
• Script that creates and cleans up a temporary file using mktemp and trap
• A review checklist ensuring modern tests, quoting disciplines, and shellcheck usage

Frequently Asked Questions