shell-script-review

Review Shell Script code for correctness, security, and maintainability.

1|Updated Dec 8, 2025
One-click install
npx skills add https://github.com/y-miyazaki/arc --skill shell-script-review-y-miyazaki
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shell-script-review
Source: https://github.com/y-miyazaki/arc/tree/main/.github/skills/shell-script-review
Command: npx skills add https://github.com/y-miyazaki/arc --skill shell-script-review-y-miyazaki

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides reviewers to assess Shell Script code for correctness, security, maintainability, and adherence to best practices, helping teams reduce bugs and insecure patterns.

Core Features & Use Cases

  • Comprehensive review checklist covering design decisions, input handling, quoting, error management, and portability.
  • PR and CI guidance for shell scripts to improve review throughput and consistency.
  • Real-world example: during a PR adding a new Bash utility, the review ensures proper shebang usage, strict mode (set -euo pipefail), safe quoting, and robust error messages.

Quick Start

Use this skill during a code review of a Bash script to identify critical issues and recommended improvements.

Frequently Asked Questions about shell-script-review

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

FAQPage Schema
How do I review a Bash script for security flaws and maintainability?

Reviewing a Bash script for security flaws involves checking shebang usage, strict mode (set -euo pipefail), safe quoting, and robust error handling. A structured checklist ensures scripts meet project standards and identify insecure patterns.

What should I look for when doing a shell script code audit?

A shell script code audit should assess design decisions, input handling, quoting, error management, and portability. Reviewing these areas ensures correctness, security, and adherence to best practices within your repository conventions.

How do I check if a shell script has proper error handling and strict mode?

Checking shell script error handling involves verifying the use of strict mode like set -euo pipefail, assessing robust error messages, and confirming safe quoting. This prevents robustness gaps and improves script reliability.

Can I use a structured checklist to streamline pull request reviews for shell scripts?

A structured checklist streamlines pull request reviews for shell scripts by covering global base, error handling, security, and maintainability. This improves review throughput and consistency for new Bash utilities.

What is the best way to ensure shell script portability and correct quoting?

The best way to ensure shell script portability and correct quoting is applying a comprehensive review checklist. This verifies input handling, safe quoting practices, and adherence to project standards during pre-merge checks.

Why does my shell script fail robustness checks during code review?

Shell scripts fail robustness checks during code review due to missing strict mode, improper quoting, or inadequate error messages. Identifying these gaps ensures correctness and maintains secure execution patterns.