shellcheck-configuration
wshobson/agents
Master ShellCheck static analysis configuration and usage for shell script quality.
What is shellcheck-configuration?
ShellCheck is a static analysis tool for shell scripts that catches common pitfalls and enforces best practices. Use this skill when setting up linting infrastructure, analyzing scripts for issues, configuring rule sets, or integrating quality checks into CI/CD pipelines and development workflows.
- Configure ShellCheck for specific project requirements and target shells
- Understand and interpret ShellCheck error codes and warnings
- Suppress false positives and customize rule sets with exclusions
- Integrate ShellCheck into CI/CD pipelines and pre-commit hooks
- Analyze existing shell scripts for quality issues and portability problems
- Enable strict mode analysis with `--enable=all` for comprehensive checking
How to install shellcheck-configuration
npx skills add https://github.com/wshobson/agents --skill shellcheck-configurationHow to use shellcheck-configuration
- 1.Install ShellCheck on your system or CI/CD environment
- 2.Configure ShellCheck for your target shell (bash, sh, ksh, etc.)
- 3.Run ShellCheck against your shell scripts to identify issues
- 4.Review error codes and warnings in the references/details.md documentation
- 5.Configure rule exclusions in a .shellcheckrc file, documenting why each is needed
- 6.Integrate ShellCheck into your CI/CD pipeline to run on every commit
- 7.Set up pre-commit hooks for local validation before pushing
- 8.Enable strict mode with `--enable=all` and carefully manage exclusions
Use cases
- Setting up automated shell script linting in CI/CD pipelines to catch issues before merging
- Analyzing legacy shell scripts to identify quality problems and migration requirements
- Configuring ShellCheck in editor integrations for real-time feedback during script development
- Enforcing consistent code quality standards across a team's shell script codebase
- Migrating scripts to meet specific quality gates and best practice standards
- DevOps engineers setting up linting infrastructure
- Shell script developers improving code quality
- CI/CD pipeline maintainers enforcing code standards
- Teams migrating legacy scripts to quality standards
shellcheck-configuration FAQ
Use the `--shell` flag to specify your target shell (bash, sh, ksh, dash, etc.). Configure this in your .shellcheckrc file or CI/CD configuration to ensure consistent analysis across your project.
Use inline directives like `# shellcheck disable=SC1234` or configure exclusions in .shellcheckrc. Always document why violations are suppressed to maintain code quality standards.
Use `--enable=all` for comprehensive checking, but carefully review and document any exclusions. Not all rules apply to every project, so configure based on your specific requirements and coding standards.
Set up pre-commit hooks for local validation, integrate into your CI/CD pipeline, and configure editor plugins for real-time feedback during development.
Keep ShellCheck current to benefit from new checks and improvements. Regular updates help catch emerging issues and maintain alignment with shell scripting best practices.
Full instructions (SKILL.md)
Source of truth, from wshobson/agents.
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
- 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=allwith 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
Related skills
More from wshobson/agents and the wider catalog.
signed-audit-trails-recipe
Cryptographically signed audit trails for Claude Code tool calls with Cedar policy enforcement.
similarity-search-patterns
Implement efficient similarity search with vector databases for semantic retrieval and nearest neighbor queries.
slo-implementation
Define and implement Service Level Indicators (SLIs), Service Level Objectives (SLOs), and error budgets for measurable reliability targets.
social-publishing
Schedule and publish posts across 13 social platforms (X, LinkedIn, Instagram, TikTok, Discord, etc.) via one API key.
solidity-security
Master smart contract security best practices and prevent common Solidity vulnerabilities.
spark-environment-setup
Set up PyTorch/Unsloth/TRL on NVIDIA DGX Spark (aarch64, CUDA 13) without ABI mismatches.