agentleFS
Destynova2Destynova2/cli-code-skills/cli-audit-shell/SKILL.md

cli-audit-shell

Skill5 starsChanged 8 months agoMITView on GitHub

Audit shell scripts against Google Shell Style Guide + ops best practices. Scores 12 dimensions: strict mode coherence, error surfaces, logging, stderr hygiene, variable discipline, quoting, control flow, naming, CLI ergonomics, idempotency, namespace, and security. Goes beyond shellcheck — detects semantic anti-patterns invisible to linters (dead fallbacks under set -e, custom loggers vs logger(1), redundant package checks, env var injection in heredocs, missing getopts). Use when reviewing shell scripts, auditing bash code, checking deployment scripts, or saying 'audit shell', 'bash review', 'script quality', 'shell style', 'shellcheck not enough', 'review my script'. Also triggers on 'set -euo pipefail', 'getopts', 'shell injection', 'logger', 'bash best practices', 'google shell style'.

1 other project uses a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 1 is distinctive, and 7 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If a specific .sh file: audit that file deeply

    line 45
  2. Very specific:

    If a directory: audit all .sh files and shebanged scripts in it

    line 46
  3. Very specific:

    If empty: find all shell scripts in the project (glob /*.sh + grep #!/bin/bash or #!/usr/bin/env bash)

    line 47
  4. Distinctive:

    If shellcheck is not installed, note it and proceed with manual analysis.

    line 92
  5. Very specific:

    Read references/categories.md for detailed checks.

    line 96
  6. Very specific:

    Read references/anti-patterns.md for named anti-patterns with detection heuristics.

    line 100
  7. Very specific:

    Read references/tooling-ladder.md for the complexity-adapted tooling decision tree.

    line 104
  8. Very specific:

    Read references/scoring.md for the SQI formula, severity classification, and benchmarks.

    line 108

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Optimization: This skill uses on-demand loading. Heavy content lives in references/ and is loaded only when needed.

Language rule: Skill instructions are written in English. This skill targets Bash scripts exclusively. When generating user-facing output, detect the project's primary language (from README, comments, docs, commit messages) and produce the report in that language. If the project is bilingual, ask the user which language to use before proceeding.

Audit Shell — Shell Quality Index (SQI)

"Shell should only be used for small utilities or simple wrapper scripts." — Google Shell Style Guide

Core Principles

  1. Evidence-based — every finding needs a file:line reference. No vague "the script could be better"
  2. Proportional — a 500-line script doing LVM partitioning matters more than a 10-line wrapper. Scale to script complexity
  3. Beyond shellcheck — shellcheck catches syntax; this skill catches semantic anti-patterns (dead code under set -e, redundant package checks, injections in heredocs)
  4. Named anti-patterns — use the anti-pattern names from references/anti-patterns.md in findings
  5. Positive reinforcement — always highlight good practices found
  6. Complexity-adapted tooling — simple problems deserve simple tools (sed), complex problems deserve proper tools (kustomize). Read references/tooling-ladder.md
  7. Gotchas — read ../gotchas.md before producing output to avoid known mistakes

Input

$ARGUMENTS is the target to audit (file path, directory, or empty for auto-detect).

  • If a specific .sh file: audit that file deeply
  • If a directory: audit all .sh files and shebanged scripts in it
  • If empty: find all shell scripts in the project (glob **/*.sh + grep #!/bin/bash or #!/usr/bin/env bash)

12-Dimension Framework

Score each dimension 0.0-1.0, then compute a weighted SQI. Read references/categories.md for detailed checklists per category.

#CategoryWeightKey question
S1Strict Mode Coherence12%Is set -euo pipefail used AND is code compatible with it? No dead fallbacks?
S2Error Surfaces & Return Values12%Are return values checked? No || true? No swallowed 2>/dev/null?
S3Logging & Observability8%Uses logger(1) or structured output? Timestamps? Severity levels?
S4Stderr Hygiene5%Errors to stderr, output to stdout? No blanket 2>/dev/null?
S5Variable Discipline10%local in functions? No unquoted expansions? No injection in heredocs?
S6Quoting & Expansion8%"${var}" not $var? Arrays for lists? "$@" not $*?
S7Control Flow & Structure8%main() pattern? Functions near top? Early returns? Max depth 3?
S8Naming Conventions5%lower_snake_case functions? UPPER_CASE constants? :: for packages?
S9CLI Ergonomics10%getopts/getopt for options? --help? Single entry point vs N scripts? S9 follows the canonical surface mapping in ../shared/cli-ergonomics.md (Laws 1-3 applied to shell).
S10Idempotency & Safety10%Check-before-create? No destructive assumptions? readonly for constants?
S11Namespace & Env Hygiene7%Env vars prefixed by project? No global pollution? local everywhere?
S12Security & Injection5%No eval? No unquoted user input in commands? No shell injection in env blocks?

Workflow

Step 1 — Discover, sample, and detect language

Glob for shell scripts: **/*.sh, **/Makefile, shebanged files. For broad audit, prioritize: entry points (setup.sh, install.sh, deploy.sh), longest scripts, most-changed scripts (git log).

Detect output language: git log --oneline -10 + head -20 README.md. Report in the project's language (French commits → French report).

Step 2 — Detect script context

Classify each script:

TypeCharacteristicsAdjusted expectations
Installer/bootstrapRuns as root, creates users/mountsS10 (idempotency) weight ×1.5, S12 (security) weight ×1.5
Library (sourced)Has .sh extension, no shebang execS8 (naming) weight ×1.5, S9 (CLI) weight ×0
Wrapper/glue< 50 lines, calls other toolsLighter audit overall, S7 (structure) weight ×0.5
Build/CI scriptIn .github/, .gitlab-ci/, MakefileS2 (errors) weight ×1.5

Step 3 — Run shellcheck first

shellcheck -x -S style <file>

If shellcheck is not installed, note it and proceed with manual analysis. Shellcheck findings go into the report but don't duplicate them in the dimension scores — this skill adds what shellcheck cannot see.

Step 4 — Score all 12 dimensions

Read references/categories.md for detailed checks. For each category: collect evidence, assign score 0.0-1.0, note specific file:line findings.

Step 5 — Detect anti-patterns

Read references/anti-patterns.md for named anti-patterns with detection heuristics. These are the semantic patterns shellcheck cannot find.

Step 6 — Assess tooling fit

Read references/tooling-ladder.md for the complexity-adapted tooling decision tree. Flag scripts that use sed/awk for YAML when they should use yq/kustomize. Flag scripts that use kustomize for a 3-variable substitution when sed would suffice.

Step 7 — Compute SQI and generate report

Read references/scoring.md for the SQI formula, severity classification, and benchmarks.

SQI = Sigma(wi x si) / Sigma(wi) x 10

Finding tier and confidence semantics are canonical in ../shared/triage.md (Tier 3/2/1 + GRADE + triangulation). S-dimension findings carry tier and confidence so cli-cycle can aggregate without re-parsing.

Output Format

# Shell Audit -- {project-name}

**Target**: [file/directory] | **Scripts found**: [N] | **Date**: [date]
**SQI Score**: X.X/10 -- {verdict}
**Shellcheck**: [N warnings, M errors] (or "not available")

## Scores by Category

| # | Category | Weight | Score | Weighted | Key findings |
|---|----------|--------|-------|----------|-------------|
| S1-S12 rows with 0.0-1.0 scores... |
| | **SQI** | **100%** | | **X.X/10** | |

## Anti-Patterns Detected
| # | Pattern | Severity | File:Line | Recommendation |

## Critical Violations (must fix)
### [Category]: [violation title]
- **File**: `path/to/file:123`
- **What**: [description]
- **Why**: [named principle it violates + Google Shell Style Guide reference]
- **Fix**: [concrete code suggestion]

## Flags (should fix)
[same format]

## Tooling Recommendations
| Current tool | Used for | Recommended | Why |
[complexity-adapted tooling analysis]

## Good Practices Found
[positive reinforcement]

## Recommended Next Steps
1. [highest-impact fix first]
2. [second]
3. [third]

What this skill does NOT do

  • Does not replace shellcheck — it complements it with semantic analysis shellcheck can't do
  • Does not fix scripts — it reports. Use the findings to guide refactoring
  • Does not audit non-shell code — YAML, Dockerfiles, Terraform go to cli-forge-infra
  • Does not audit test strategy — use cli-audit-test for that
  • Does not audit code topology — use cli-audit-tangle for call graph analysis

Integration with other cli-* skills

SkillRelationship
cli-audit-codeScores code quality generically. cli-audit-shell goes deep on bash semantics
cli-forge-infraAudits infra config and ops patterns. cli-audit-shell audits the scripts themselves
cli-audit-tangleDetects structural coupling. cli-audit-shell detects bash-specific structural issues
cli-forge-pipelineOptimizes CI/CD pipelines. cli-audit-shell audits shell scripts used in CI
cli-cycleShould call cli-audit-shell as part of full project review when shell scripts exist; emit .claude/cli-audit-shell.json per ../shared/result-schema.md for orchestrator aggregation

Dynamic Handoffs

Condition detectedRecommendWhy
Sed on YAML/JSON (AP7 Sed Surgeon)/cli-forge-infraTooling ladder assessment, kustomize/yq recommendation
Multiple scripts without getopts (AP8 Script Hydra)/cli-audit-wizardUX audit of the setup/init flow
Shell injection risk in env blocks (AP9)/cli-audit-code on the consuming codeVerify the sourcing code validates inputs
Scripts are CI/CD entrypoints/cli-forge-pipelinePipeline-level optimization
Script > 100 lines with god functions/cli-audit-tangleTopology analysis for split points
Entrypoints with wait-for/sleep/nc -z loops or sed on app config/cli-audit-hanoiDisplacement audit: trace the hack to the missing app capability

Rule: Recommend, don't auto-execute.

Reference Sources

  • Google — Shell Style Guide (primary authority)
  • Wooledge — BashGuide, BashFAQ, BashPitfalls
  • ShellCheck — SC1000-SC9999 rule database
  • Kfir Lavi — Defensive Bash Programming
  • Dylan Araps — Pure Bash Bible
  • Greg Wooledge — Bash Idioms (O'Reilly)
  • SixArm — Unix Shell Script Tactics (XDG compliance, NO_COLOR standard, portability catalog)
  • clig.dev — Command Line Interface Guidelines (CLI ergonomics, --json, --dry-run)
  • no-color.org — NO_COLOR standard (color output gating)
  • POSIX.1-2024 — Shell Command Language specification

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.