shell-conventions

Community

Safe, portable shell scripting conventions.

Authorjsamuelsen11
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This set of conventions provides a comprehensive, language-agnostic guide for writing safe, readable, and portable shell scripts that work across Bash and POSIX sh, reducing common errors and security risks in automation tasks.

Core Features & Use Cases

  • Safety-focused rules: enforce strict mode usage, consistent quoting, trap-based cleanup, safe defaults, and a main() pattern to prevent accidental execution when sourced.
  • Portability and style: harmonize Bash and POSIX sh practices, promote shellcheck-friendly code, and enforce shfmt formatting for consistent style across teams; applicable to CI checks, onboarding, and code reviews.
  • Real-world use: ideal for scripting across automation, deployment tasks, and maintenance where reliability and portability matter.

Quick Start

Audit your shell scripts against the conventions and incrementally adopt the main patterns in new projects for safer, more maintainable code.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: shell-conventions
Download link: https://github.com/jsamuelsen11/claude-config/archive/main.zip#shell-conventions

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.