shell-reviewer

Review bash/sh scripts for state assumptions, error handling, and interactive behavior.

Updated Mar 7, 2016
One-click install
npx skills add https://github.com/BarrettLowe/dotfiles --skill shell-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shell-reviewer
Source: https://github.com/BarrettLowe/dotfiles/tree/main/claude/skills/shell-reviewer
Command: npx skills add https://github.com/BarrettLowe/dotfiles --skill shell-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the limitations of automated script checkers by providing in-depth, human-level analysis of bash/sh scripts for complex issues that cannot be caught by linters.

Core Features & Use Cases

  • Expert Script Review: Identify issues like state assumptions, trap hygiene, and interactive intent.
  • Complements Shellcheck: Focuses on areas beyond what shellcheck can catch.
  • Use Case: Before merging shell changes or auditing scripts in CI/CD pipelines, use this Skill to ensure robust, error-free execution.

Quick Start

Review the 'merge_script.sh' for potential issues.

Frequently Asked Questions about shell-reviewer

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

FAQPage Schema
How do I review shell scripts for issues not caught by automated linters?

Reviewing shell scripts for advanced issues requires analyzing state assumptions, trap hygiene, and interactive behavior beyond automated linters. This Skill provides human-level script analysis to identify complex execution problems in bash/sh scripts intended for CI/CD pipelines or SSH.

Does this script analysis replace shellcheck for CI/CD pipeline reviews?

This script analysis complements shellcheck rather than replacing it. While shellcheck handles automated linting, this Skill focuses on advanced issues like state assumptions, trap hygiene, and error handling tailored for unattended execution in CI/CD pipelines or over SSH.

How do I check bash scripts for unattended execution issues over SSH?

Checking bash scripts for unattended execution over SSH involves analyzing interactive behavior and error handling. This Skill reviews scripts to identify hidden state assumptions and interactive intent that could cause failures during remote execution.

What is the best way to audit shell scripts before merging in a CI/CD pipeline?

The best way to audit shell scripts before merging is to perform expert review focusing on trap hygiene and error handling. This Skill analyzes bash/sh scripts to ensure robust, error-free execution in CI/CD pipelines by catching complex issues automated checkers miss.

Why does my shell script fail in CI/CD pipelines but pass local linting checks?

Shell scripts failing in CI/CD pipelines despite passing local linting often hide state assumptions or interactive behaviors. This Skill provides detailed review to detect advanced execution issues that automated script checkers cannot catch.

Can I use this to analyze scripts with complex trap hygiene and error handling?

Yes, you can use this to analyze scripts with complex trap hygiene and error handling. The Skill provides detailed review of bash/sh scripts specifically targeting these advanced issues to ensure robust execution in unattended environments like CI/CD pipelines.