Bash Defensive Patterns

From the author

Master defensive Bash programming techniques for production-grade scripts. Use when writing robust shell scripts, CI/CD pipelines, or system utilities requiring fault tolerance and safety.

— the description by Ryan Snodgrass

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured approach to writing robust Bash scripts by implementing defensive programming patterns. It focuses on error handling, safety, and maintainability, ensuring that scripts are resilient to edge cases, prevent common pitfalls like word splitting, and behave predictably in production environments. The content covers essential practices such as enabling strict mode, implementing proper cleanup with traps, safe variable handling, and robust argument parsing.

What it does

Defines strict mode settings to catch errors early
Provides patterns for safe temporary file and directory management
Demonstrates robust error trapping and cleanup techniques
Outlines best practices for variable quoting and conditional logic
Offers templates for structured function design and argument parsing
Encourages idempotent and testable script design

When to use it

When developing production-grade automation scripts
When writing scripts for CI/CD pipelines
When creating system administration utilities
When building scripts that require high reliability and fault tolerance

Advantages

Reduces runtime errors through strict mode and input validation
Improves script maintainability and readability
Ensures predictable behavior across different environments
Prevents common security and stability issues like word splitting

Usage examples

“How do I ensure my Bash script stops immediately if a command fails?”: The skill recommends enabling strict mode by adding 'set -Eeuo pipefail' at the beginning of the script to ensure it exits on errors, unset variables, and pipe failures.
“What is the safest way to handle temporary files in a script?”: The skill provides a pattern using 'mktemp -d' to create a unique directory and a 'trap' command to ensure the directory is automatically removed upon script exit.

Install

Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/wshobson/bash-defensive-patterns/download

Unzip it into the cross-client skills folder of your project:

mkdir -p .agents/skills && unzip bash-defensive-patterns.zip -d .agents/skills

Documentation by Ryan Snodgrass

Comprehensive guidance for writing production-ready Bash scripts using defensive programming techniques, error handling, and safety best practices to prevent common pitfalls and ensure reliability.

When to Use This Skill

Writing production automation scripts
Building CI/CD pipeline scripts
Creating system administration utilities
Developing error-resilient deployment automation
Writing scripts that must handle edge cases safely
Building maintainable shell script libraries
Implementing comprehensive logging and monitoring
Creating scripts that must work across different platforms

Detailed patterns and worked examples

Detailed pattern documentation lives in references/details.md. Read that file when the navigation tier above is insufficient.

Best Practices Summary

Always use strict mode - set -Eeuo pipefail
Quote all variables - "$variable" prevents word splitting
Use [[]] conditionals - More robust than [ ]
Implement error trapping - Catch and handle errors gracefully
Validate all inputs - Check file existence, permissions, formats
Use functions for reusability - Prefix with meaningful names
Implement structured logging - Include timestamps and levels
Support dry-run mode - Allow users to preview changes
Handle temporary files safely - Use mktemp, cleanup with trap
Design for idempotency - Scripts should be safe to rerun
Document requirements - List dependencies and minimum versions
Test error paths - Ensure error handling works correctly
Use command -v - Safer than which for checking executables
Prefer printf over echo - More predictable across systems

Files

ATTRIBUTION.mdAdded by AutoGineer896 B
LICENSELicence file added by AutoGineer1.0 KiB
SKILL.md1.9 KiB
references/details.md9.8 KiB

SKILL.md