1---2name: bash-pro3description: 'Master of defensive Bash scripting for production automation, CI/CD45 pipelines, and system utilities. Expert in safe, portable, and testable shell67 scripts.89 '10risk: critical11source: community12date_added: '2026-02-27'13metadata:14 source: https://skillmd.com/skills/antigravity/bash-pro15---1617## Use this skill when1819- Writing or reviewing Bash scripts for automation, CI/CD, or ops20- Hardening shell scripts for safety and portability2122## Do not use this skill when2324- You need POSIX-only shell without Bash features25- The task requires a higher-level language for complex logic26- You need Windows-native scripting (PowerShell)2728## Instructions29301. Define script inputs, outputs, and failure modes.312. Apply strict mode and safe argument parsing.323. Implement core logic with defensive patterns.334. Add tests and linting with Bats and ShellCheck.3435## Safety3637- Treat input as untrusted; avoid eval and unsafe globbing.38- Prefer dry-run modes before destructive actions.3940## Focus Areas4142- Defensive programming with strict error handling43- POSIX compliance and cross-platform portability44- Safe argument parsing and input validation45- Robust file operations and temporary resource management46- Process orchestration and pipeline safety47- Production-grade logging and error reporting48- Comprehensive testing with Bats framework49- Static analysis with ShellCheck and formatting with shfmt50- Modern Bash 5.x features and best practices51- CI/CD integration and automation workflows5253## Approach5455- Always use strict mode with `set -Eeuo pipefail` and proper error trapping56- Quote all variable expansions to prevent word splitting and globbing issues57- Prefer arrays and proper iteration over unsafe patterns like `for f in $(ls)`58- Use `[[ ]]` for Bash conditionals, fall back to `[ ]` for POSIX compliance59- Implement comprehensive argument parsing with `getopts` and usage functions60- Create temporary files and directories safely with `mktemp` and cleanup traps61- Prefer `printf` over `echo` for predictable output formatting62- Use command substitution `$()` instead of backticks for readability63- Implement structured logging with timestamps and configurable verbosity64- Design scripts to be idempotent and support dry-run modes65- Use `shopt -s inherit_errexit` for better error propagation in Bash 4.4+66- Employ `IFS=$'\n\t'` to prevent unwanted word splitting on spaces67- Validate inputs with `: "${VAR:?message}"` for required environment variables68- End option parsing with `--` and use `rm -rf -- "$dir"` for safe operations69- Support `--trace` mode with `set -x` opt-in for detailed debugging70- Use `xargs -0` with NUL boundaries for safe subprocess orchestration71- Employ `readarray`/`mapfile` for safe array population from command output72- Implement robust script directory detection: `SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P)"`73- Use NUL-safe patterns: `find -print0 | while IFS= read -r -d '' file; do ...; done`7475## Compatibility & Portability7677- Use `#!/usr/bin/env bash` shebang for portability across systems78- Check Bash version at script start: `(( BASH_VERSINFO[0] >= 4 && BASH_VERSINFO[1] >= 4 ))` for Bash 4.4+ features79- Validate required external commands exist: `command -v jq &>/dev/null || exit 1`80- Detect platform differences: `case "$(uname -s)" in Linux*) ... ;; Darwin*) ... ;; esac`81- Handle GNU vs BSD tool differences (e.g., `sed -i` vs `sed -i ''`)82- Test scripts on all target platforms (Linux, macOS, BSD variants)83- Document minimum version requirements in script header comments84- Provide fallback implementations for platform-specific features85- Use built-in Bash features over external commands when possible for portability86- Avoid bashisms when POSIX compliance is required, document when using Bash-specific features8788## Readability & Maintainability8990- Use long-form options in scripts for clarity: `--verbose` instead of `-v`91- Employ consistent naming: snake_case for functions/variables, UPPER_CASE for constants92- Add section headers with comment blocks to organize related functions93- Keep functions under 50 lines; refactor larger functions into smaller components94- Group related functions together with descriptive section headers95- Use descriptive function names that explain purpose: `validate_input_file` not `check_file`96- Add inline comments for non-obvious logic, avoid stating the obvious97- Maintain consistent indentation (2 or 4 spaces, never tabs mixed with spaces)98- Place opening braces on same line for consistency: `function_name() {`99- Use blank lines to separate logical blocks within functions100- Document function parameters and return values in header comments101- Extract magic numbers and strings to named constants at top of script102103## Safety & Security Patterns104105- Declare constants with `readonly` to prevent accidental modification106- Use `local` keyword for all function variables to avoid polluting global scope107- Implement `timeout` for external commands: `timeout 30s curl ...` prevents hangs108- Validate file permissions before operations: `[[ -r "$file" ]] || exit 1`109- Use process substitution `<(command)` instead of temporary files when possible110- Sanitize user input before using in commands or file operations111- Validate numeric input with pattern matching: `[[ $num =~ ^[0-9]+$ ]]`112- Never use `eval` on user input; use arrays for dynamic command construction113- Set restrictive umask for sensitive operations: `(umask 077; touch "$secure_file")`114- Log security-relevant operations (authentication, privilege changes, file access)115- Use `--` to separate options from arguments: `rm -rf -- "$user_input"`116- Validate environment variables before using: `: "${REQUIRED_VAR:?not set}"`117- Check exit codes of all security-critical operations explicitly118- Use `trap` to ensure cleanup happens even on abnormal exit119120## Performance Optimization121122- Avoid subshells in loops; use `while read` instead of `for i in $(cat file)`123- Use Bash built-ins over external commands: `[[ ]]` instead of `test`, `${var//pattern/replacement}` instead of `sed`124- Batch operations instead of repeated single operations (e.g., one `sed` with multiple expressions)125- Use `mapfile`/`readarray` for efficient array population from command output126- Avoid repeated command substitutions; store result in variable once127- Use arithmetic expansion `$(( ))` instead of `expr` for calculations128- Prefer `printf` over `echo` for formatted output (faster and more reliable)129- Use associative arrays for lookups instead of repeated grepping130- Process files line-by-line for large files instead of loading entire file into memory131- Use `xargs -P` for parallel processing when operations are independent132133## Documentation Standards134135- Implement `--help` and `-h` flags showing usage, options, and examples136- Provide `--version` flag displaying script version and copyright information137- Include usage examples in help output for common use cases138- Document all command-line options with descriptions of their purpose139- List required vs optional arguments clearly in usage message140- Document exit codes: 0 for success, 1 for general errors, specific codes for specific failures141- Include prerequisites section listing required commands and versions142- Add header comment block with script purpose, author, and modification date143- Document environment variables the script uses or requires144- Provide troubleshooting section in help for common issues145- Generate documentation with `shdoc` from special comment formats146- Create man pages using `shellman` for system integration147- Include architecture diagrams using Mermaid or GraphViz for complex scripts148149## Modern Bash Features (5.x)150151- **Bash 5.0**: Associative array improvements, `${var@U}` uppercase conversion, `${var@L}` lowercase152- **Bash 5.1**: Enhanced `${parameter@operator}` transformations, `compat` shopt options for compatibility153- **Bash 5.2**: `varredir_close` option, improved `exec` error handling, `EPOCHREALTIME` microsecond precision154- Check version before using modern features: `[[ ${BASH_VERSINFO[0]} -ge 5 && ${BASH_VERSINFO[1]} -ge 2 ]]`155- Use `${parameter@Q}` for shell-quoted output (Bash 4.4+)156- Use `${parameter@E}` for escape sequence expansion (Bash 4.4+)157- Use `${parameter@P}` for prompt expansion (Bash 4.4+)158- Use `${parameter@A}` for assignment format (Bash 4.4+)159- Employ `wait -n` to wait for any background job (Bash 4.3+)160- Use `mapfile -d delim` for custom delimiters (Bash 4.4+)161162## CI/CD Integration163164- **GitHub Actions**: Use `shellcheck-problem-matchers` for inline annotations165- **Pre-commit hooks**: Configure `.pre-commit-config.yaml` with `shellcheck`, `shfmt`, `checkbashisms`166- **Matrix testing**: Test across Bash 4.4, 5.0, 5.1, 5.2 on Linux and macOS167- **Container testing**: Use official bash:5.2 Docker images for reproducible tests168- **CodeQL**: Enable shell script scanning for security vulnerabilities169- **Actionlint**: Validate GitHub Actions workflow files that use shell scripts170- **Automated releases**: Tag versions and generate changelogs automatically171- **Coverage reporting**: Track test coverage and fail on regressions172- Example workflow: `shellcheck *.sh && shfmt -d *.sh && bats test/`173174## Security Scanning & Hardening175176- **SAST**: Integrate Semgrep with custom rules for shell-specific vulnerabilities177- **Secrets detection**: Use `gitleaks` or `trufflehog` to prevent credential leaks178- **Supply chain**: Verify checksums of sourced external scripts179- **Sandboxing**: Run untrusted scripts in containers with restricted privileges180- **SBOM**: Document dependencies and external tools for compliance181- **Security linting**: Use ShellCheck with security-focused rules enabled182- **Privilege analysis**: Audit scripts for unnecessary root/sudo requirements183- **Input sanitization**: Validate all external inputs against allowlists184- **Audit logging**: Log all security-relevant operations to syslog185- **Container security**: Scan script execution environments for vulnerabilities186187## Observability & Logging188189- **Structured logging**: Output JSON for log aggregation systems190- **Log levels**: Implement DEBUG, INFO, WARN, ERROR with configurable verbosity191- **Syslog integration**: Use `logger` command for system log integration192- **Distributed tracing**: Add trace IDs for multi-script workflow correlation193- **Metrics export**: Output Prometheus-format metrics for monitoring194- **Error context**: Include stack traces, environment info in error logs195- **Log rotation**: Configure log file rotation for long-running scripts196- **Performance metrics**: Track execution time, resource usage, external call latency197- Example: `log_info() { logger -t "$SCRIPT_NAME" -p user.info "$*"; echo "[INFO] $*" >&2; }`198199## Quality Checklist200201- Scripts pass ShellCheck static analysis with minimal suppressions202- Code is formatted consistently with shfmt using standard options203- Comprehensive test coverage with Bats including edge cases204- All variable expansions are properly quoted205- Error handling covers all failure modes with meaningful messages206- Temporary resources are cleaned up properly with EXIT traps207- Scripts support `--help` and provide clear usage information208- Input validation prevents injection attacks and handles edge cases209- Scripts are portable across target platforms (Linux, macOS)210- Performance is adequate for expected workloads and data sizes211212## Output213214- Production-ready Bash scripts with defensive programming practices215- Comprehensive test suites using bats-core or shellspec with TAP output216- CI/CD pipeline configurations (GitHub Actions, GitLab CI) for automated testing217- Documentation generated with shdoc and man pages with shellman218- Structured project layout with reusable library functions and dependency management219- Static analysis configuration files (.shellcheckrc, .shfmt.toml, .editorconfig)220- Performance benchmarks and profiling reports for critical workflows221- Security review with SAST, secrets scanning, and vulnerability reports222- Debugging utilities with trace modes, structured logging, and observability223- Migration guides for Bash 3→5 upgrades and legacy modernization224- Package distribution configurations (Homebrew formulas, deb/rpm specs)225- Container images for reproducible execution environments226227## Essential Tools228229### Static Analysis & Formatting230- **ShellCheck**: Static analyzer with `enable=all` and `external-sources=true` configuration231- **shfmt**: Shell script formatter with standard config (`-i 2 -ci -bn -sr -kp`)232- **checkbashisms**: Detect bash-specific constructs for portability analysis233- **Semgrep**: SAST with custom rules for shell-specific security issues234- **CodeQL**: GitHub's security scanning for shell scripts235236### Testing Frameworks237- **bats-core**: Maintained fork of Bats with modern features and active development238- **shellspec**: BDD-style testing framework with rich assertions and mocking239- **shunit2**: xUnit-style testing framework for shell scripts240- **bashing**: Testing framework with mocking support and test isolation241242### Modern Development Tools243- **bashly**: CLI framework generator for building command-line applications244- **basher**: Bash package manager for dependency management245- **bpkg**: Alternative bash package manager with npm-like interface246- **shdoc**: Generate markdown documentation from shell script comments247- **shellman**: Generate man pages from shell scripts248249### CI/CD & Automation250- **pre-commit**: Multi-language pre-commit hook framework251- **actionlint**: GitHub Actions workflow linter252- **gitleaks**: Secrets scanning to prevent credential leaks253- **Makefile**: Automation for lint, format, test, and release workflows254255## Common Pitfalls to Avoid256257- `for f in $(ls ...)` causing word splitting/globbing bugs (use `find -print0 | while IFS= read -r -d '' f; do ...; done`)258- Unquoted variable expansions leading to unexpected behavior259- Relying on `set -e` without proper error trapping in complex flows260- Using `echo` for data output (prefer `printf` for reliability)261- Missing cleanup traps for temporary files and directories262- Unsafe array population (use `readarray`/`mapfile` instead of command substitution)263- Ignoring binary-safe file handling (always consider NUL separators for filenames)264265## Dependency Management266267- **Package managers**: Use `basher` or `bpkg` for installing shell script dependencies268- **Vendoring**: Copy dependencies into project for reproducible builds269- **Lock files**: Document exact versions of dependencies used270- **Checksum verification**: Verify integrity of sourced external scripts271- **Version pinning**: Lock dependencies to specific versions to prevent breaking changes272- **Dependency isolation**: Use separate directories for different dependency sets273- **Update automation**: Automate dependency updates with Dependabot or Renovate274- **Security scanning**: Scan dependencies for known vulnerabilities275- Example: `basher install username/repo@version` or `bpkg install username/repo -g`276277## Advanced Techniques278279- **Error Context**: Use `trap 'echo "Error at line $LINENO: exit $?" >&2' ERR` for debugging280- **Safe Temp Handling**: `trap 'rm -rf "$tmpdir"' EXIT; tmpdir=$(mktemp -d)`281- **Version Checking**: `(( BASH_VERSINFO[0] >= 5 ))` before using modern features282- **Binary-Safe Arrays**: `readarray -d '' files < <(find . -print0)`283- **Function Returns**: Use `declare -g result` for returning complex data from functions284- **Associative Arrays**: `declare -A config=([host]="localhost" [port]="8080")` for complex data structures285- **Parameter Expansion**: `${filename%.sh}` remove extension, `${path##*/}` basename, `${text//old/new}` replace all286- **Signal Handling**: `trap cleanup_function SIGHUP SIGINT SIGTERM` for graceful shutdown287- **Command Grouping**: `{ cmd1; cmd2; } > output.log` share redirection, `( cd dir && cmd )` use subshell for isolation288- **Co-processes**: `coproc proc { cmd; }; echo "data" >&"${proc[1]}"; read -u "${proc[0]}" result` for bidirectional pipes289- **Here-documents**: `cat <<-'EOF'` with `-` strips leading tabs, quotes prevent expansion290- **Process Management**: `wait $pid` to wait for background job, `jobs -p` list background PIDs291- **Conditional Execution**: `cmd1 && cmd2` run cmd2 only if cmd1 succeeds, `cmd1 || cmd2` run cmd2 if cmd1 fails292- **Brace Expansion**: `touch file{1..10}.txt` creates multiple files efficiently293- **Nameref Variables**: `declare -n ref=varname` creates reference to another variable (Bash 4.3+)294- **Improved Error Trapping**: `set -Eeuo pipefail; shopt -s inherit_errexit` for comprehensive error handling295- **Parallel Execution**: `xargs -P $(nproc) -n 1 command` for parallel processing with CPU core count296- **Structured Output**: `jq -n --arg key "$value" '{key: $key}'` for JSON generation297- **Performance Profiling**: Use `time -v` for detailed resource usage or `TIMEFORMAT` for custom timing298299## References & Further Reading300301### Style Guides & Best Practices302- [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html) - Comprehensive style guide covering quoting, arrays, and when to use shell303- [Bash Pitfalls](https://mywiki.wooledge.org/BashPitfalls) - Catalog of common Bash mistakes and how to avoid them304- [Bash Hackers Wiki](https://wiki.bash-hackers.org/) - Comprehensive Bash documentation and advanced techniques305- [Defensive BASH Programming](https://www.kfirlavi.com/blog/2012/11/14/defensive-bash-programming/) - Modern defensive programming patterns306307### Tools & Frameworks308- [ShellCheck](https://github.com/koalaman/shellcheck) - Static analysis tool and extensive wiki documentation309- [shfmt](https://github.com/mvdan/sh) - Shell script formatter with detailed flag documentation310- [bats-core](https://github.com/bats-core/bats-core) - Maintained Bash testing framework311- [shellspec](https://github.com/shellspec/shellspec) - BDD-style testing framework for shell scripts312- [bashly](https://bashly.dannyb.co/) - Modern Bash CLI framework generator313- [shdoc](https://github.com/reconquest/shdoc) - Documentation generator for shell scripts314315### Security & Advanced Topics316- [Bash Security Best Practices](https://github.com/carlospolop/PEASS-ng) - Security-focused shell script patterns317- [Awesome Bash](https://github.com/awesome-lists/awesome-bash) - Curated list of Bash resources and tools318- [Pure Bash Bible](https://github.com/dylanaraps/pure-bash-bible) - Collection of pure bash alternatives to external commands319320## Limitations321- Use this skill only when the task clearly matches the scope described above.322- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.323- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.