shell-engineering

Apply Google's Shell Style Guide to write and review Bash scripts.

5|1|Updated Jul 30, 2010
One-click install
npx skills add https://github.com/gonzaloserrano/dotfiles --skill shell-engineering
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shell-engineering
Source: https://github.com/gonzaloserrano/dotfiles/tree/main/claude/skills/shell-engineering
Command: npx skills add https://github.com/gonzaloserrano/dotfiles --skill shell-engineering

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides comprehensive guidelines to help write production-quality shell scripts by applying Google's Shell Style Guide, reducing errors and improving maintainability across Bash projects.

Core Features & Use Cases

  • Standardized bash conventions for function naming, variable scoping, error handling, and script structure.
  • Practical guidance for writing portable scripts, testing, and performing code reviews.
  • Use Case: Starting a new Bash utility or reviewing an existing script to align with industry best practices.

Quick Start

Use the shell-engineering skill to review a new Bash script and apply Google's Shell Style Guide.

Frequently Asked Questions about shell-engineering

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the best practices for writing maintainable Bash scripts?

Maintainable Bash scripts require consistent function naming, proper variable scoping, strict quoting rules, and structured error handling. Applying guidelines like Google's Shell Style Guide enforces these conventions, reducing errors and improving script readability across development and operations teams.

How do I review an existing shell script for style guide compliance?

Reviewing a shell script for style guide compliance involves checking script structure, naming conventions, quoting rules, and error handling. This skill evaluates existing Bash scripts against Google's Shell Style Guide to ensure they meet industry best practices for production quality.

How do I structure a new Bash utility to align with industry standards?

Structuring a new Bash utility requires enforcing script structure, naming conventions, and documentation requirements from the start. Applying standardized shell conventions ensures the utility is portable, testable, and maintainable throughout its lifecycle.

Does this approach to shell scripting support portable code across different environments?

Yes, applying shell style guidelines provides practical guidance for writing portable scripts. By enforcing consistent quoting and variable scoping rules, the approach ensures Bash scripts run reliably across different development and operations environments.

Why does my Bash script fail without proper error handling conventions?

Bash scripts often fail silently without proper error handling conventions because variable scoping and quoting rules are not enforced. Applying a strict style guide requires explicit error handling and testing, which prevents unexpected failures in production environments.

Can I use these shell scripting guidelines for team code reviews?

Yes, these shell scripting guidelines are designed for teaching teams best practices and performing code reviews. They provide standardized conventions for evaluating Bash scripts, ensuring consistency and maintainability across collaborative development projects.