1---2name: bash-pro3description: |4 Master of defensive Bash scripting for production automation, CI/CD5 pipelines, and system utilities. Expert in safe, portable, and testable shell6 scripts.7metadata:8 source: https://skillmd.com/skills/mayurrathi/bash-pro9 model: sonnet10risk: unknown11source: community12---1314## Use this skill when1516- Writing or reviewing Bash scripts for automation, CI/CD, or ops17- Hardening shell scripts for safety and portability1819## Do not use this skill when2021- You need POSIX-only shell without Bash features22- The task requires a higher-level language for complex logic23- You need Windows-native scripting (PowerShell)2425## Instructions26271. Define script inputs, outputs, and failure modes.282. Apply strict mode and safe argument parsing.293. Implement core logic with defensive patterns.304. Add tests and linting with Bats and ShellCheck.3132## Safety3334- Treat input as untrusted; avoid eval and unsafe globbing.35- Prefer dry-run modes before destructive actions.3637## Focus Areas3839- Defensive programming with strict error handling40- POSIX compliance and cross-platform portability41- Safe argument parsing and input validation42- Robust file operations and temporary resource management43- Process orchestration and pipeline safety44- Production-grade logging and error reporting45- Comprehensive testing with Bats framework46- Static analysis with ShellCheck and formatting with shfmt47- Modern Bash 5.x features and best practices48- CI/CD integration and automation workflows4950## Approach5152- Always use strict mode with `set -Eeuo pipefail` and proper error trapping53- Quote all variable expansions to prevent word splitting and globbing issues54- Prefer arrays and proper iteration over unsafe patterns like `for f in $(ls)`55- Use `[[ ]]` for Bash conditionals, fall back to `[ ]` for POSIX compliance56- Implement comprehensive argument parsing with `getopts` and usage functions57- Create temporary files and directories safely with `mktemp` and cleanup traps58- Prefer `printf` over `echo` for predictable output formatting59- Use command substitution `$()` instead of backticks for readability60- Implement structured logging with timestamps and configurable verbosity61- Design scripts to be idempotent and support dry-run modes62- Use `shopt -s inherit_errexit` for better error propagation in Bash 4.4+63- Employ `IFS=$'\n\t'` to prevent unwanted word splitting on spaces64- Validate inputs with `: "${VAR:?message}"` for required environment variables65- End option parsing with `--` and use `rm -rf -- "$dir"` for safe operations66- Support `--trace` mode with `set -x` opt-in for detailed debugging67- Use `xargs -0` with NUL boundaries for safe subprocess orchestration68- Employ `readarray`/`mapfile` for safe array population from command output69- Implement robust script directory detection: `SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P)"`70- Use NUL-safe patterns: `find -print0 | while IFS= read -r -d '' file; do ...; done`7172## Compatibility & Portability7374- Use `#!/usr/bin/env bash` shebang for portability across systems75- Check Bash version at script start: `(( BASH_VERSINFO[0] >= 4 && BASH_VERSINFO[1] >= 4 ))` for Bash 4.4+ features76- Validate required external commands exist: `command -v jq &>/dev/null || exit 1`77- Detect platform differences: `case "$(uname -s)" in Linux*) ... ;; Darwin*) ... ;; esac`78- Handle GNU vs BSD tool differences (e.g., `sed -i` vs `sed -i ''`)79- Test scripts on all target platforms (Linux, macOS, BSD variants)80- Document minimum version requirements in script header comments81- Provide fallback implementations for platform-specific features82- Use built-in Bash features over external commands when possible for portability83- Avoid bashisms when POSIX compliance is required, document when using Bash-specific features8485## Readability & Maintainability8687- Use long-form options in scripts for clarity: `--verbose` instead of `-v`88- Employ consistent naming: snake_case for functions/variables, UPPER_CASE for constants89- Add section headers with comment blocks to organize related functions90- Keep functions under 50 lines; refactor larger functions into smaller components91- Group related functions together with descriptive section headers92- Use descriptive function names that explain purpose: `validate_input_file` not `check_file`93- Add inline comments for non-obvious logic, avoid stating the obvious94- Maintain consistent indentation (2 or 4 spaces, never tabs mixed with spaces)95- Place opening braces on same line for consistency: `function_name() {`96- Use blank lines to separate logical blocks within functions97- Document function parameters and return values in header comments98- Extract magic numbers and strings to named constants at top of script99100## Safety & Security Patterns101102- Declare constants with `readonly` to prevent accidental modification103- Use `local` keyword for all function variables to avoid polluting global scope104- Implement `timeout` for external commands: `timeout 30s curl ...` prevents hangs105- Validate file permissions before operations: `[[ -r "$file" ]] || exit 1`106- Use process substitution `<(command)` instead of temporary files when possible107- Sanitize user input before using in commands or file operations108- Validate numeric input with pattern matching: `[[ $num =~ ^[0-9]+$ ]]`109- Never use `eval` on user input; use arrays for dynamic command construction110- Set restrictive umask for sensitive operations: `(umask 077; touch "$secure_file")`111- Log security-relevant operations (authentication, privilege changes, file access)112- Use `--` to separate options from arguments: `rm -rf -- "$user_input"`113- Validate environment variables before using: `: "${REQUIRED_VAR:?not set}"`114- Check exit codes of all security-critical operations explicitly115- Use `trap` to ensure cleanup happens even on abnormal exit116117## Performance Optimization118119- Avoid subshells in loops; use `while read` instead of `for i in $(cat file)`120- Use Bash built-ins over external commands: `[[ ]]` instead of `test`, `${var//pattern/replacement}` instead of `sed`121- Batch operations instead of repeated single operations (e.g., one `sed` with multiple expressions)122- Use `mapfile`/`readarray` for efficient array population from command output123- Avoid repeated command substitutions; store result in variable once124- Use arithmetic expansion `$(( ))` instead of `expr` for calculations125- Prefer `printf` over `echo` for formatted output (faster and more reliable)126- Use associative arrays for lookups instead of repeated grepping127- Process files line-by-line for large files instead of loading entire file into memory128- Use `xargs -P` for parallel processing when operations are independent129130## Documentation Standards131132- Implement `--help` and `-h` flags showing usage, options, and examples133- Provide `--version` flag displaying script version and copyright information134- Include usage examples in help output for common use cases135- Document all command-line options with descriptions of their purpose136- List required vs optional arguments clearly in usage message137- Document exit codes: 0 for success, 1 for general errors, specific codes for specific failures138- Include prerequisites section listing required commands and versions139- Add header comment block with script purpose, author, and modification date140- Document environment variables the script uses or requires141- Provide troubleshooting section in help for common issues142- Generate documentation with `shdoc` from special comment formats143- Create man pages using `shellman` for system integration144- Include architecture diagrams using Mermaid or GraphViz for complex scripts145146## Modern Bash Features (5.x)147148- **Bash 5.0**: Associative array improvements, `${var@U}` uppercase conversion, `${var@L}` lowercase149- **Bash 5.1**: Enhanced `${parameter@operator}` transformations, `compat` shopt options for compatibility150- **Bash 5.2**: `varredir_close` option, improved `exec` error handling, `EPOCHREALTIME` microsecond precision151- Check version before using modern features: `[[ ${BASH_VERSINFO[0]} -ge 5 && ${BASH_VERSINFO[1]} -ge 2 ]]`152- Use `${parameter@Q}` for shell-quoted output (Bash 4.4+)153- Use `${parameter@E}` for escape sequence expansion (Bash 4.4+)154- Use `${parameter@P}` for prompt expansion (Bash 4.4+)155- Use `${parameter@A}` for assignment format (Bash 4.4+)156- Employ `wait -n` to wait for any background job (Bash 4.3+)157- Use `mapfile -d delim` for custom delimiters (Bash 4.4+)158159## CI/CD Integration160161- **GitHub Actions**: Use `shellcheck-problem-matchers` for inline annotations162- **Pre-commit hooks**: Configure `.pre-commit-config.yaml` with `shellcheck`, `shfmt`, `checkbashisms`163- **Matrix testing**: Test across Bash 4.4, 5.0, 5.1, 5.2 on Linux and macOS164- **Container testing**: Use official bash:5.2 Docker images for reproducible tests165- **CodeQL**: Enable shell script scanning for security vulnerabilities166- **Actionlint**: Validate GitHub Actions workflow files that use shell scripts167- **Automated releases**: Tag versions and generate changelogs automatically168- **Coverage reporting**: Track test coverage and fail on regressions169- Example workflow: `shellcheck *.sh && shfmt -d *.sh && bats test/`170171## Security Scanning & Hardening172173- **SAST**: Integrate Semgrep with custom rules for shell-specific vulnerabilities174- **Secrets detection**: Use `gitleaks` or `trufflehog` to prevent credential leaks175- **Supply chain**: Verify checksums of sourced external scripts176- **Sandboxing**: Run untrusted scripts in containers with restricted privileges177- **SBOM**: Document dependencies and external tools for compliance178- **Security linting**: Use ShellCheck with security-focused rules enabled179- **Privilege analysis**: Audit scripts for unnecessary root/sudo requirements180- **Input sanitization**: Validate all external inputs against allowlists181- **Audit logging**: Log all security-relevant operations to syslog182- **Container security**: Scan script execution environments for vulnerabilities183184## Observability & Logging185186- **Structured logging**: Output JSON for log aggregation systems187- **Log levels**: Implement DEBUG, INFO, WARN, ERROR with configurable verbosity188- **Syslog integration**: Use `logger` command for system log integration189- **Distributed tracing**: Add trace IDs for multi-script workflow correlation190- **Metrics export**: Output Prometheus-format metrics for monitoring191- **Error context**: Include stack traces, environment info in error logs192- **Log rotation**: Configure log file rotation for long-running scripts193- **Performance metrics**: Track execution time, resource usage, external call latency194- Example: `log_info() { logger -t "$SCRIPT_NAME" -p user.info "$*"; echo "[INFO] $*" >&2; }`195196## Quality Checklist197198- Scripts pass ShellCheck static analysis with minimal suppressions199- Code is formatted consistently with shfmt using standard options200- Comprehensive test coverage with Bats including edge cases201- All variable expansions are properly quoted202- Error handling covers all failure modes with meaningful messages203- Temporary resources are cleaned up properly with EXIT traps204- Scripts support `--help` and provide clear usage information205- Input validation prevents injection attacks and handles edge cases206- Scripts are portable across target platforms (Linux, macOS)207- Performance is adequate for expected workloads and data sizes208209## Output210211- Production-ready Bash scripts with defensive programming practices212- Comprehensive test suites using bats-core or shellspec with TAP output213- CI/CD pipeline configurations (GitHub Actions, GitLab CI) for automated testing214- Documentation generated with shdoc and man pages with shellman215- Structured project layout with reusable library functions and dependency management216- Static analysis configuration files (.shellcheckrc, .shfmt.toml, .editorconfig)217- Performance benchmarks and profiling reports for critical workflows218- Security review with SAST, secrets scanning, and vulnerability reports219- Debugging utilities with trace modes, structured logging, and observability220- Migration guides for Bash 3→5 upgrades and legacy modernization221- Package distribution configurations (Homebrew formulas, deb/rpm specs)222- Container images for reproducible execution environments223224## Essential Tools225226### Static Analysis & Formatting227- **ShellCheck**: Static analyzer with `enable=all` and `external-sources=true` configuration228- **shfmt**: Shell script formatter with standard config (`-i 2 -ci -bn -sr -kp`)229- **checkbashisms**: Detect bash-specific constructs for portability analysis230- **Semgrep**: SAST with custom rules for shell-specific security issues231- **CodeQL**: GitHub's security scanning for shell scripts232233### Testing Frameworks234- **bats-core**: Maintained fork of Bats with modern features and active development235- **shellspec**: BDD-style testing framework with rich assertions and mocking236- **shunit2**: xUnit-style testing framework for shell scripts237- **bashing**: Testing framework with mocking support and test isolation238239### Modern Development Tools240- **bashly**: CLI framework generator for building command-line applications241- **basher**: Bash package manager for dependency management242- **bpkg**: Alternative bash package manager with npm-like interface243- **shdoc**: Generate markdown documentation from shell script comments244- **shellman**: Generate man pages from shell scripts245246### CI/CD & Automation247- **pre-commit**: Multi-language pre-commit hook framework248- **actionlint**: GitHub Actions workflow linter249- **gitleaks**: Secrets scanning to prevent credential leaks250- **Makefile**: Automation for lint, format, test, and release workflows251252## Common Pitfalls to Avoid253254- `for f in $(ls ...)` causing word splitting/globbing bugs (use `find -print0 | while IFS= read -r -d '' f; do ...; done`)255- Unquoted variable expansions leading to unexpected behavior256- Relying on `set -e` without proper error trapping in complex flows257- Using `echo` for data output (prefer `printf` for reliability)258- Missing cleanup traps for temporary files and directories259- Unsafe array population (use `readarray`/`mapfile` instead of command substitution)260- Ignoring binary-safe file handling (always consider NUL separators for filenames)261262## Dependency Management263264- **Package managers**: Use `basher` or `bpkg` for installing shell script dependencies265- **Vendoring**: Copy dependencies into project for reproducible builds266- **Lock files**: Document exact versions of dependencies used267- **Checksum verification**: Verify integrity of sourced external scripts268- **Version pinning**: Lock dependencies to specific versions to prevent breaking changes269- **Dependency isolation**: Use separate directories for different dependency sets270- **Update automation**: Automate dependency updates with Dependabot or Renovate271- **Security scanning**: Scan dependencies for known vulnerabilities272- Example: `basher install username/repo@version` or `bpkg install username/repo -g`273274## Advanced Techniques275276- **Error Context**: Use `trap 'echo "Error at line $LINENO: exit $?" >&2' ERR` for debugging277- **Safe Temp Handling**: `trap 'rm -rf "$tmpdir"' EXIT; tmpdir=$(mktemp -d)`278- **Version Checking**: `(( BASH_VERSINFO[0] >= 5 ))` before using modern features279- **Binary-Safe Arrays**: `readarray -d '' files < <(find . -print0)`280- **Function Returns**: Use `declare -g result` for returning complex data from functions281- **Associative Arrays**: `declare -A config=([host]="localhost" [port]="8080")` for complex data structures282- **Parameter Expansion**: `${filename%.sh}` remove extension, `${path##*/}` basename, `${text//old/new}` replace all283- **Signal Handling**: `trap cleanup_function SIGHUP SIGINT SIGTERM` for graceful shutdown284- **Command Grouping**: `{ cmd1; cmd2; } > output.log` share redirection, `( cd dir && cmd )` use subshell for isolation285- **Co-processes**: `coproc proc { cmd; }; echo "data" >&"${proc[1]}"; read -u "${proc[0]}" result` for bidirectional pipes286- **Here-documents**: `cat <<-'EOF'` with `-` strips leading tabs, quotes prevent expansion287- **Process Management**: `wait $pid` to wait for background job, `jobs -p` list background PIDs288- **Conditional Execution**: `cmd1 && cmd2` run cmd2 only if cmd1 succeeds, `cmd1 || cmd2` run cmd2 if cmd1 fails289- **Brace Expansion**: `touch file{1..10}.txt` creates multiple files efficiently290- **Nameref Variables**: `declare -n ref=varname` creates reference to another variable (Bash 4.3+)291- **Improved Error Trapping**: `set -Eeuo pipefail; shopt -s inherit_errexit` for comprehensive error handling292- **Parallel Execution**: `xargs -P $(nproc) -n 1 command` for parallel processing with CPU core count293- **Structured Output**: `jq -n --arg key "$value" '{key: $key}'` for JSON generation294- **Performance Profiling**: Use `time -v` for detailed resource usage or `TIMEFORMAT` for custom timing295296## References & Further Reading297298### Style Guides & Best Practices299- [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html) - Comprehensive style guide covering quoting, arrays, and when to use shell300- [Bash Pitfalls](https://mywiki.wooledge.org/BashPitfalls) - Catalog of common Bash mistakes and how to avoid them301- [Bash Hackers Wiki](https://wiki.bash-hackers.org/) - Comprehensive Bash documentation and advanced techniques302- [Defensive BASH Programming](https://www.kfirlavi.com/blog/2012/11/14/defensive-bash-programming/) - Modern defensive programming patterns303304### Tools & Frameworks305- [ShellCheck](https://github.com/koalaman/shellcheck) - Static analysis tool and extensive wiki documentation306- [shfmt](https://github.com/mvdan/sh) - Shell script formatter with detailed flag documentation307- [bats-core](https://github.com/bats-core/bats-core) - Maintained Bash testing framework308- [shellspec](https://github.com/shellspec/shellspec) - BDD-style testing framework for shell scripts309- [bashly](https://bashly.dannyb.co/) - Modern Bash CLI framework generator310- [shdoc](https://github.com/reconquest/shdoc) - Documentation generator for shell scripts311312### Security & Advanced Topics313- [Bash Security Best Practices](https://github.com/carlospolop/PEASS-ng) - Security-focused shell script patterns314- [Awesome Bash](https://github.com/awesome-lists/awesome-bash) - Curated list of Bash resources and tools315- [Pure Bash Bible](https://github.com/dylanaraps/pure-bash-bible) - Collection of pure bash alternatives to external commands