Index of every page on this site: llms.txt
All skills
wshobson avatar

/shellcheck-configuration

@4220308
by Seth Hobsonwshobson/agents43k stars
4,518
Run it yourself

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

Use this Skill: https://skilld.dev/gh/wshobson/agents/shellcheck-configuration

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈51 tokens for metadata: the name and description. ≈344 when used: this file. ≈2k more on demand in 1 file.

Description uses 2.6% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈206 characters, or 2.6%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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

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

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo5 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill provides comprehensive documentation and configuration examples for ShellCheck, a standard static analysis tool for shell scripts. It covers configuration files, CI/CD integration, and common error resolutions without introducing any security risks.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • Runlayer8mo

    1/1 file flagged

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at 4220308. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 days ago.

Activeupdated 6 months ago
  • shellcheck
  • shell
  • bash
  • linting
  • static-analysis
  • ci-cd
  • code-quality
  • sh

README badge

README badge for wshobson/agents/shellcheck-configuration

Configures and integrates ShellCheck static analysis for shell script linting, covering error codes, rule suppression, CI/CD integration, and editor setup. Use when establishing shell script quality gates, analyzing existing scripts for issues, or enforcing portability standards across bash and sh targets.

Generated from the current SKILL.md.

Does this skill cover ShellCheck configuration for specific shells like bash vs sh?
Yes. The skill includes guidance on configuring ShellCheck for your target shell and emphasizes not analyzing bash as sh.
Can I use this skill to suppress false positives in ShellCheck?
Yes. The skill covers suppressing false positives and configuring rule sets, including documentation of exclusions.
Does this skill help integrate ShellCheck into CI/CD pipelines?
Yes. The skill includes patterns for running ShellCheck in CI/CD, setting up linting infrastructure, and integrating with pre-commit hooks and editors.

Generated from the current SKILL.md. These answers refresh after source changes.