ShellCheck Setup Guide

ShellCheck Configuration and Static Analysis

by wshobson · MIT license · ★ 39,857 on GitHub · updated Sep 21

Master ShellCheck static analysis configuration and usage for shell script quality. Use when setting up linting infrastructure, fixing code issues, or ensuring script portability.

---
name: shellcheck-configuration
description: Master ShellCheck static analysis configuration and usage for shell script quality. Use when setting up linting infrastructure, fixing code issues, or ensuring script portability.
---

# ShellCheck Configuration and Static Analysis

Comprehensive guidance for configuring and using ShellCheck to improve shell script quality, catch common pitfalls, and enforce best practices through static code analysis.

## When to Use This Skill

- Setting up linting for shell scripts in CI/CD pipelines
- Analyzing existing shell scripts for issues
- Understanding ShellCheck error codes and warnings
- Configuring ShellCheck for specific project requirements
- Integrating ShellCheck into development workflows
- Suppressing false positives and configuring rule sets
- Enforcing consistent code quality standards

Overview

Comprehensive guidance for configuring and using ShellCheck to improve shell script quality, catch common pitfalls, and enforce best practices through static code analysis.

Manual install (npx, ZIP)

Claude Codenpx skills add wshobson/agents --skill shellcheck-configuration -g -a claude-code

Claude Code (manual)

mkdir -p ~/.claude/skills && curl -sL https://codeload.github.com/wshobson/agents/tar.gz/4236bb91f839 \
  | tar -xz -C ~/.claude/skills --strip-components=4 agents-4236bb91f839/plugins/shell-scripting/skills/shellcheck-configuration

Windows (PowerShell)

New-Item -ItemType Directory -Force "$HOME\.claude\skills" | Out-Null; Invoke-WebRequest "https://m.agentalley.io/zip/dfb8db443bf6a39e2f41/shellcheck-configuration.zip" -OutFile "$env:TEMP\shellcheck-configuration.zip"; Expand-Archive "$env:TEMP\shellcheck-configuration.zip" -DestinationPath "$HOME\.claude\skills" -Force

Claude.ai / desktopDownload the ZIP and upload it under Settings → Capabilities → Skills.

Codex, Cursor, other agentsPoint them at SKILL.md. The other files are plain text.

Connects with Agent Alley MCP · agentalley.io/mcp

Files included

SKILL.md1.6 KB
references/1 file · 7.8 KB

Read the files here

wshobson/4236bb92 files

SKILL.md1.6 KB

SKILL.md

Show the full text35 lines

shellcheck-configuration/SKILL.md35 lines · 1.6 KB

PreviewCode

Outline

RawView on GitHub

ShellCheck Configuration and Static Analysis

Comprehensive guidance for configuring and using ShellCheck to improve shell script quality, catch common pitfalls, and enforce best practices through static code analysis.

When to Use This Skill

Setting up linting for shell scripts in CI/CD pipelines
Analyzing existing shell scripts for issues
Understanding ShellCheck error codes and warnings
Configuring ShellCheck for specific project requirements
Integrating ShellCheck into development workflows
Suppressing false positives and configuring rule sets
Enforcing consistent code quality standards
Migrating scripts to meet quality gates

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

Run ShellCheck in CI/CD - Catch issues before merging
Configure for your target shell - Don't analyze bash as sh
Document exclusions - Explain why violations are suppressed
Address violations - Don't just disable warnings
Enable strict mode - Use --enable=all with careful exclusions
Update regularly - Keep ShellCheck current for new checks
Use pre-commit hooks - Catch issues locally before pushing
Integrate with editors - Get real-time feedback during development

1	---
2	name: shellcheck-configuration
3	description: Master ShellCheck static analysis configuration and usage for shell script quality. Use when setting up linting infrastructure, fixing code issues, or ensuring script portability.
4	---
5
6	# ShellCheck Configuration and Static Analysis
7
8	Comprehensive guidance for configuring and using ShellCheck to improve shell script quality, catch common pitfalls, and enforce best practices through static code analysis.
9
10	## When to Use This Skill
11
12	- Setting up linting for shell scripts in CI/CD pipelines
13	- Analyzing existing shell scripts for issues
14	- Understanding ShellCheck error codes and warnings
15	- Configuring ShellCheck for specific project requirements
16	- Integrating ShellCheck into development workflows
17	- Suppressing false positives and configuring rule sets
18	- Enforcing consistent code quality standards
19	- Migrating scripts to meet quality gates
20
21	## Detailed patterns and worked examples
22
23	Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient.
24
25	## Best Practices
26
27	1. Run ShellCheck in CI/CD - Catch issues before merging
28	2. Configure for your target shell - Don't analyze bash as sh
29	3. Document exclusions - Explain why violations are suppressed
30	4. Address violations - Don't just disable warnings
31	5. Enable strict mode - Use `--enable=all` with careful exclusions
32	6. Update regularly - Keep ShellCheck current for new checks
33	7. Use pre-commit hooks - Catch issues locally before pushing
34	8. Integrate with editors - Get real-time feedback during development
35