Skip to content

Repository files navigation

DeepGrade

DeepGrade gives your codebase a letter grade. AI-powered codebase auditing, planning, operational readiness assessment, and documentation generation. Stack-agnostic. Works on any codebase.

What It Does

DeepGrade asks three questions about your codebase:

Pillar Question Time Orientation
1. Documentation as the Foundation What do we have? Past
2. Phased Delivery Over Big-Bang Releases What shape is it in? Present
3. Operational Readiness Can we safely change it? Future

Install DeepGrade Plugin

Prerequisite: Claude Code installed (claude.ai)

Step 1: Open a terminal (not inside Claude Code) and run:

claude plugin marketplace add krwhynot/deepgrade

Step 2: Then run:

claude plugin install deepgrade@deepgrade-marketplace --scope user

Step 3: Start Claude Code in any project:

claude

Step 4: Verify:

/deepgrade:help

Commands (16)

Planning

Command Description
/deepgrade:plan 9-phase structured planning workflow
/deepgrade:quick-plan Lightweight plan for small changes
/deepgrade:plan-status Check plan progress and phase status
/deepgrade:plan-export Export a plan as a portable package

Auditing

Command Description
/deepgrade:codebase-audit Full codebase audit across all three pillars
/deepgrade:quick-audit Audit any technical plan or spec
/deepgrade:codebase-delta Compare against previous audit baseline
/deepgrade:codebase-characterize Generate codebase characterization

Operational Readiness

Command Description
/deepgrade:readiness-scan AI readiness scan (9 categories, letter grade)
/deepgrade:readiness-generate Generate improvement recs
/deepgrade:codebase-gates Set up quality gates and baseline tracking
/deepgrade:codebase-security Security-focused audit

Documentation

Command Description
/deepgrade:documentation Generate specs, PRDs, BRDs, ADRs, READMEs
/deepgrade:quick-cleanup Identify and fix common codebase issues
/deepgrade:troubleshoot 4-phase debugging framework with incident triage and containment
/deepgrade:help Show all commands and usage

Safety Hooks (8)

The plugin includes 8 safety hooks that activate automatically. They are declared in hooks/hooks.json and run as Node scripts from scripts/, one file per handler. Requires Node.js 18 or later — the same runtime Claude Code itself needs.

Hook Event What It Does
Active Plan Display SessionStart Reports the active plan, its phase, and audit staleness
Migration Guard PreToolUse Write/Edit Blocks edits to existing migrations
Git + DB Guard PreToolUse Bash Blocks force push and direct DB deploys; asks before a hard reset
Change Tracker PostToolUse Write/Edit Counts file changes, nudges when an audit is stale
Test/Build Tracker PostToolUse Bash Records test and build runs
Session Summary Stop Reports file change count and warns if no tests ran
Subagent Log SubagentStop Logs subagent completions to the active plan
Plan Context PreCompact Preserves plan name and phase on compact

Database Deploy Guard

Blocks direct database migration deploys from local machine. Supports:

Blocked Command Stack Safe Exception
supabase db push Supabase --dry-run, --local
prisma migrate deploy Prisma --dry-run
dotnet ef database update .NET EF Core -
flyway migrate Flyway -
rails db:migrate Rails RAILS_ENV=test, development

Dependencies

Required: Node.js 18 or later — the same runtime Claude Code itself needs, so if Claude Code runs, this does too.

node --version   # must print v18.0.0 or higher

Not required: jq. Versions before 5.0.0 parsed hook payloads with jq, falling back to grep+sed when it was absent. That fallback is gone, and its removal was the point rather than a side effect: grep and sed are not a JSON parser, so the guards could not distinguish a command from text that merely mentioned one. They blocked a read-only grep whose search pattern named a deployment, and blocked commit messages that referred to a force push.

What happens without Node. The hooks cannot start, and Claude Code reports a hook error on each guarded event. That is deliberate: the previous design degraded quietly to a weaker parser, so you could not tell a working safety layer from a broken one. Absent and loud beats present and wrong.

Supported Stacks

The plugin auto-detects your stack. Tested on:

Stack Detection
Node/React/TypeScript package.json, tsconfig.json
.NET (C#/VB.NET) *.sln, *.csproj, *.vbproj
Python pyproject.toml, setup.py, requirements.txt
Rust Cargo.toml
Go go.mod

File Output Locations

Output Location Committed?
Audit reports docs/audit/ Yes
Plan documents docs/plans/{date}-{name}/ Yes
Specifications docs/specs/ Yes
ADRs docs/adr/ Yes
Session markers $TMPDIR/dg-* (%TEMP% on Windows) No (OS-managed)

Architecture

  • 22 agents - Specialized scanners and generators
  • 6 skills - Docs, governance, readiness, knowledge, self-audit, MCP research
  • 6 doc templates - ADR, BRD, PRD, README, release notes, spec
  • 8 hook handlers - scripts/dg-*.js, the runtime safety layer (was labelled "reference, not runtime" before 5.0.0, which is now inverted: F06 exists precisely to stop unwired code shipping)

Version History

See CHANGELOG.md for full history.

Current: v5.0.0

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT. See LICENSE.

About

DeepGrade: AI-powered codebase grading, planning, auditing, and operational readiness. Claude Code plugin.

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages