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

cli-audit-code

Skill5 starsChanged 8 months agoMITView on GitHub

Audit code quality with weighted scoring across 12 dimensions (naming, complexity, module design, DRY, errors, security, tests, architecture). Detects named anti-patterns (Fowler/Mantyla taxonomy). Use when reviewing code quality, auditing clean code compliance, checking for code smells, or saying 'audit code', 'code quality', 'code review', 'tech debt'. Invoke with an optional file or directory path.

  • Reads credentials

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

10 rules. About 0 are common, 5 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If a specific file: audit that file deeply

    line 32
  2. Distinctive:

    If a directory: audit all source files in it

    line 33
  3. Very specific:

    If empty: audit src/ broadly (sample 15-20 key files)

    line 34
  4. Distinctive:

    Do not read a large source file end-to-end as the first step.

    line 63
  5. Very specific:

    When evidence points at a line, read a bounded slice around it: about 75 lines before and after, 150 lines max by default.

    line 66
  6. Distinctive:

    Read a full file only when it is 300 lines or less, or when whole-file semantics are required.

    line 67
  7. Very specific:

    Prefer RTK wrappers for noisy shell output when available: rtk git, rtk cargo, rtk grep, rtk find, and bounded rtk read.

    line 69
  8. Very specific:

    Read references/categories.md for detailed checks.

    line 77
  9. Very specific:

    Read references/scoring.md for the CQI formula, severity classification, named anti-patterns table, tech debt estimation, and comparative …

    line 81
  10. Distinctive:

    After your analysis, recommend these skills if conditions are met:

    line 149

≈ “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. 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 Code — Code Quality Index (CQI)

"Complexity is the single greatest enemy of reliability." — John Ousterhout

Core Principles

  1. Evidence-based — every finding needs a file:line reference. No vague "the code could be better"
  2. Proportional — a 200-line function matters more than a missing doc comment. Scale to project type
  3. Language-aware — detect the project language and apply its idiomatic patterns, not Java/C# defaults
  4. Named anti-patterns — use Fowler/Mantyla taxonomy names (Feature Envy, Shotgun Surgery) in findings
  5. Positive reinforcement — always highlight good practices found, not just violations
  6. Gotchas — read ../gotchas.md before producing output to avoid known mistakes

Input

$ARGUMENTS is the target to audit (file path, directory, or empty for whole src/).

  • If a specific file: audit that file deeply
  • If a directory: audit all source files in it
  • If empty: audit src/ broadly (sample 15-20 key files)

12-Dimension Framework

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

#CategoryWeightKey question
C1Naming & Readability8%Do names reveal intent? No magic numbers?
C2Functions & Cognitive Complexity12%< 30 lines? Cognitive complexity < 15?
C3Module Design (deep vs shallow)10%Deep modules? No pass-through layers?
C4DRY & Change Amplification8%One change = one file? No copy-paste?
C5Error Handling & Robustness10%Errors propagated? No swallowed errors?
C6Type Safety & Language Idioms8%Type system leveraged? Idiomatic patterns?
C7Comments & Public API Docs5%Public API documented? No redundant comments?
C8Test Quality12%Error paths tested? No flaky tests?
C9Security & Input Validation10%Inputs validated at boundaries? No hardcoded secrets?
C10Immutability & State Management7%Minimal mutable state? No global mutables?
C11Cognitive Load & Control Flow5%< 3 nesting levels? No negative conditionals?
C12Dependencies & Architecture5%No circular deps? DIP respected?

Workflow

Step 1 — Discover and sample

Glob source files. For broad audit, prioritize: entry points, public API modules, most-changed files (git log), largest files.

Context Budget Rule

Do not read a large source file end-to-end as the first step.

  • For files over 300 lines or directory audits, start with inventory only: file list, line counts, symbol or function index, git churn, and focused risk greps.
  • When evidence points at a line, read a bounded slice around it: about 75 lines before and after, 150 lines max by default. Use nl -ba path | sed -n 'START,ENDp', sed -n 'START,ENDp', or rtk read -n -m 150 path when RTK is available.
  • Read a full file only when it is 300 lines or less, or when whole-file semantics are required. State that reason in the report.
  • Reuse previously read slices and line references instead of re-reading the same file.
  • Prefer RTK wrappers for noisy shell output when available: rtk git, rtk cargo, rtk grep, rtk find, and bounded rtk read. Do not treat generic rtk log output as authoritative for structured JSON logs unless a domain-specific filter verifies it.

Step 2 — Detect language and context

Identify project language, framework, and type (library, CLI, service, script). This determines which idiom checks apply and what scoring standards are proportional.

Step 3 — 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 4 — Compute CQI and detect anti-patterns

Read references/scoring.md for the CQI formula, severity classification, named anti-patterns table, tech debt estimation, and comparative benchmarks.

CQI = Σ(wᵢ × sᵢ) / Σ(wᵢ) × 10

Step 5 — Generate report

Finding tier and confidence semantics are canonical in ../shared/triage.md (Tier 3/2/1 + GRADE + triangulation). Emit each finding with its tier and confidence so cli-cycle can aggregate without re-parsing.

Output Format

# Code Quality Audit — {project-name}

**Target**: [file/directory] | **Language**: [detected] | **Date**: [date]
**CQI Score**: X.X/10 — {verdict} | **Tech Debt**: ~Xh ({SQALE grade})

## Scores by Category

| # | Category | Weight | Score | Weighted | Findings |
|---|----------|--------|-------|----------|----------|
| C1-C12 rows with 0.0-1.0 scores... |
| | **CQI** | **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/smell it violates]
- **Fix**: [concrete suggestion]
- **Disproof**: [observation that would invalidate this finding — e.g., "this isn't dead code IF dynamic dispatch is used here"]

## Flags (should fix)
[same format]

## 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 fix code — it reports. Use the findings to guide refactoring
  • Does not replace linters — it complements them with semantic analysis a linter can't do
  • Does not check test coverage numbers — it checks test quality. Use cli-audit-test for test strategy
  • Does not audit documentation quality — use cli-audit-doc for that

Integration with other cli-* skills

SkillRelationship
cli-audit-xrayTurns static hidden-cost smells (repeated work, clones, allocations, bad cache placement) into optimization cards with invariants and validation
cli-audit-docScores doc quality. cli-audit-code scores code quality
cli-audit-testScores test strategy. cli-audit-code checks test code quality (C8)
cli-forge-lldValidates implementation matches the LLD design
cli-forge-perfDetects static perf anti-patterns (alloc in hot path, quadratic complexity, hidden-cost abstractions). cli-forge-perf verifies they are dynamically costly via profiling + bench
cli-cycleCalls cli-audit-code as part of full project review; emit .claude/cli-audit-code.json per ../shared/result-schema.md for orchestrator aggregation

Dynamic Handoffs

After your analysis, recommend these skills if conditions are met:

Condition detectedRecommendWhy
Repeated computation, allocation/copy churn, cache-before-normalization, or dataflow cost with unclear safety/cli-audit-xrayBuild semantic/resource-flow candidates before recommending a rewrite
God class/module (C3 > 500 lines, many responsibilities)/cli-audit-tangleTopology analysis reveals optimal split points
Hardcoded secrets or .env tracked in git (C9)/cli-git-conventional --audit-markersCheck git history for leaked secrets
Shell scripts in the project with quality issues/cli-audit-shellDeep bash-specific audit beyond C6 idioms
Missing or stale documentation (C7 low)/cli-forge-docGenerate/update project docs
Test quality issues (C8 low)/cli-audit-testFull test strategy audit
CI/CD config present but not audited/cli-forge-pipelinePipeline optimization
Static perf anti-pattern detected (alloc in loop, O(n²), N+1) on a hot service/cli-forge-perfConfirm the dynamic cost and lock the fix with an A/B bench gate
PostgreSQL/SQLx flow has read-before-write, split transactions, ignored zero-row writes, or tenant-key gaps/cli-audit-dataProve database invariants and concurrent executions

Rule: Recommend, don't auto-execute. Phrase as: "Consider running /cli-audit-tangle — 3 god modules detected that need topology analysis."

Reference Sources

  • Ousterhout — A Philosophy of Software Design | Martin — Clean Code | Fowler — Refactoring | Tornhill — Software Design X-Rays | Feathers — Working Effectively with Legacy Code
  • SonarQube Quality Model | SonarSource Cognitive Complexity | SQALE Method | CodeScene Code Health | Clippy lint categories
  • CodeAesthetic | ThePrimeagen | ArjanCodes | Software Engineering Radio | Tech Lead Journal

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.