Best use case
project-health-check is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
It is a strong fit for teams already working in Codex.
Analyze overall project health and metrics
Teams using project-health-check should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/project-health-check/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How project-health-check Compares
| Feature / Agent | project-health-check | Standard Approach |
|---|---|---|
| Platform Support | Codex | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Analyze overall project health and metrics
Which AI agents support this skill?
This skill is designed for Codex.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
Cursor vs Codex for AI Workflows
Compare Cursor and Codex for AI coding workflows, repository assistance, debugging, refactoring, and reusable developer skills.
AI Agents for Coding
Browse AI agent skills for coding, debugging, testing, refactoring, code review, and developer workflows across Claude, Cursor, and Codex.
AI Agents for Marketing
Discover AI agents for marketing workflows, from SEO and content production to campaign research, outreach, and analytics.
SKILL.md Source
# Project Health Check Analyze overall project health and metrics ## Instructions 1. **Health Check Initialization** - Verify tool connections (Linear, GitHub) - Define evaluation period (default: last 30 days) - Set health check criteria and thresholds - Identify key metrics to evaluate 2. **Multi-Dimensional Analysis** #### Code Health Metrics ```bash # Code churn analysis git log --format=format: --name-only --since="30 days ago" | sort | uniq -c | sort -rg # Contributor activity git shortlog -sn --since="30 days ago" # Branch health git for-each-ref --format='%(refname:short) %(committerdate:relative)' refs/heads/ | grep -E "(months|years) ago" # File complexity (if cloc available) cloc . --json --exclude-dir=node_modules,dist,build # Test coverage trends npm test -- --coverage --json ``` #### Dependency Health ```bash # Check for outdated dependencies npm outdated --json # Security vulnerabilities npm audit --json # License compliance npx license-checker --json ``` #### Linear/Task Management Health ``` 1. Sprint velocity trends 2. Cycle time analysis 3. Blocked task duration 4. Backlog growth rate 5. Bug vs feature ratio 6. Task completion predictability ``` #### Team Health Indicators ``` 1. PR review turnaround time 2. Commit frequency distribution 3. Work distribution balance 4. On-call incident frequency 5. Documentation updates ``` 3. **Health Report Generation** ```markdown # Project Health Report - [Project Name] Generated: [Date] ## Executive Summary Overall Health Score: [Score]/100 [🟢 Healthy | 🟡 Needs Attention | 🔴 Critical] ### Key Findings - ✅ Strengths: [Top 3 positive indicators] - ⚠️ Concerns: [Top 3 areas needing attention] - 🚨 Critical Issues: [Immediate action items] ## Detailed Health Metrics 1. **Delivery Health** (Score: [X]/100) | Metric | Current | Target | Status | |--------|---------|--------|--------| | Sprint Velocity | [X] pts | [Y] pts | 🟢 | | On-time Delivery | [X]% | 90% | 🟡 | | Cycle Time | [X] days | [Y] days | 🟢 | | Defect Rate | [X]% | <5% | 🔴 | 2. **Code Quality** (Score: [X]/100) | Metric | Current | Target | Status | |--------|---------|--------|--------| | Test Coverage | [X]% | 80% | 🟡 | | Code Duplication | [X]% | <3% | 🟢 | | Complexity Score | [X] | <10 | 🟡 | | Security Issues | [X] | 0 | 🔴 | 3. **Technical Debt** (Score: [X]/100) - 📊 Total Debt Items: [Count] - 📈 Debt Growth Rate: [+/-X% per sprint] - ⏱️ Estimated Debt Work: [X days] - 💰 Debt Impact: [Description] 4. **Team Health** (Score: [X]/100) | Metric | Current | Target | Status | |--------|---------|--------|--------| | PR Review Time | [X] hrs | <4 hrs | 🟢 | | Knowledge Silos | [X] | 0 | 🟡 | | Work Balance | [Score] | >0.8 | 🟢 | | Burnout Risk | [Level] | Low | 🟡 | 5. **Dependency Health** (Score: [X]/100) - 🔄 Outdated Dependencies: [X]/[Total] - 🛡️ Security Vulnerabilities: [Critical: X, High: Y] - 📜 License Issues: [Count] - 🔗 External Service Health: [Status] ## Trend Analysis ### Velocity Trend (Last 6 Sprints) ``` Sprint 1: ████████████ 40 pts Sprint 2: ██████████████ 45 pts Sprint 3: ████████████████ 50 pts Sprint 4: ██████████████ 45 pts Sprint 5: ████████████ 38 pts Sprint 6: ██████████ 35 pts ⚠️ Declining ``` ### Bug Discovery Rate ``` Week 1: ██ 2 bugs Week 2: ████ 4 bugs Week 3: ██████ 6 bugs ⚠️ Increasing Week 4: ████████ 8 bugs 🚨 Action needed ``` ## Risk Assessment ### High Priority Risks 1. **Declining Velocity** - Impact: High - Likelihood: Confirmed - Mitigation: Review sprint planning process 2. **Security Vulnerabilities** - Impact: Critical - Count: [X] high, [Y] medium - Action: Immediate patching required 3. **Knowledge Concentration** - Impact: Medium - Bus Factor: 2 - Action: Implement pairing/documentation ## Actionable Recommendations ### Immediate Actions (This Week) 1. 🛡️ **Security**: Update [package] to fix critical vulnerability 2. 🐛 **Quality**: Address top 3 bug-prone modules 3. 👥 **Team**: Schedule knowledge transfer for [critical component] ### Short-term Improvements (This Sprint) 1. 📈 **Velocity**: Reduce scope to sustainable level 2. 🧪 **Testing**: Increase coverage in [module] to 80% 3. 📚 **Documentation**: Update outdated docs for [feature] ### Long-term Initiatives (This Quarter) 1. 🏗️ **Architecture**: Refactor [component] to reduce complexity 2. 🔄 **Process**: Implement automated dependency updates 3. 📊 **Metrics**: Set up continuous health monitoring ## Comparison with Previous Health Check | Category | Last Check | Current | Trend | |----------|------------|---------|-------| | Overall Score | 72/100 | 68/100 | ↓ -4 | | Delivery | 80/100 | 75/100 | ↓ -5 | | Code Quality | 70/100 | 72/100 | ↑ +2 | | Technical Debt | 65/100 | 60/100 | ↓ -5 | | Team Health | 75/100 | 70/100 | ↓ -5 | ``` 4. **Interactive Deep Dives** Offer focused analysis options: ``` "Based on the health check, would you like to: 1. Deep dive into declining velocity trends 2. Generate security vulnerability fix plan 3. Analyze technical debt hotspots 4. Create team workload rebalancing plan 5. Set up automated health monitoring" ``` ## Error Handling ### Missing Linear Connection ``` "Linear MCP not connected. Health check will be limited to: - Git/GitHub metrics only - No sprint velocity or task metrics - Manual input required for team data To enable full health analysis: 1. Install Linear MCP server 2. Configure with API credentials 3. Re-run health check" ``` ### Incomplete Data ``` "Some metrics could not be calculated: - [List missing metrics] - [Explain impact on analysis] Would you like to: 1. Proceed with available data 2. Manually provide missing information 3. Skip incomplete sections" ``` ## Customization Options ### Threshold Configuration ```yaml # health-check-config.yml thresholds: velocity_variance: 20 # Acceptable % variance test_coverage: 80 # Minimum coverage % pr_review_time: 4 # Maximum hours bug_rate: 5 # Maximum % of work dependency_age: 90 # Days before "outdated" ``` ### Custom Health Metrics Allow users to define additional metrics: ``` "Add custom health metric: - Name: Customer Satisfaction - Data Source: [API/Manual/File] - Target Value: [>4.5/5] - Weight: [Impact on overall score]" ``` ## Export Options 1. **Executive Summary** (PDF/Markdown) 2. **Detailed Report** (HTML with charts) 3. **Raw Metrics** (JSON/CSV) 4. **Action Items** (Linear tasks/GitHub issues) 5. **Monitoring Dashboard** (Grafana/Datadog format) ## Automation Suggestions ``` "Would you like me to: 1. Schedule weekly health checks 2. Set up alerts for critical metrics 3. Create Linear tasks for action items 4. Generate PR templates with health criteria 5. Configure CI/CD health gates" ``` ## Best Practices 1. **Regular Cadence**: Run health checks weekly/bi-weekly 2. **Track Trends**: Compare with historical data 3. **Action-Oriented**: Focus on fixable issues 4. **Team Involvement**: Share results transparently 5. **Continuous Improvement**: Refine metrics based on outcomes ## References - @$AIWG_ROOT/agentic/code/addons/aiwg-utils/rules/research-before-decision.md — Collect and analyze actual metrics before scoring; do not estimate health from assumptions - @$AIWG_ROOT/agentic/code/addons/aiwg-utils/rules/vague-discretion.md — Health thresholds must be numeric (e.g., test coverage ≥ 80%); never "good enough" conditions - @$AIWG_ROOT/agentic/code/frameworks/sdlc-complete/skills/project-status/SKILL.md — Provides SDLC artifact-based status; this skill provides code and team metrics - @$AIWG_ROOT/agentic/code/frameworks/sdlc-complete/skills/security-audit/SKILL.md — Security metrics feed directly into this skill's health score calculation - @$AIWG_ROOT/agentic/code/frameworks/sdlc-complete/skills/codebase-health/SKILL.md — Code structure metrics complement the project-level metrics produced here
Related Skills
eslint-checker
Run ESLint for JavaScript/TypeScript code quality and style enforcement. Use for static analysis and auto-fixing.
workspace-health
Assess workspace alignment and recommend cleanup or realignment actions at key lifecycle transition points
traceability-check
Verify bidirectional traceability from requirements to code to tests and identify coverage gaps and orphan artifacts
regression-check
Compare current behavior against baseline to detect regressions
quality-checker
Validate skill quality, completeness, and adherence to standards. Use before packaging to ensure skill meets quality requirements.
project-timeline-simulator
Simulate project outcomes with variable modeling, risk assessment, and resource optimization scenarios.
project-status
Analyze project state from .aiwg/ artifacts and provide contextual status with recommended next steps
project-awareness
Detect project type, AIWG framework state, team configuration, and active work to summarize status and recommend next actions
orchestrate-project
Plan iterations, delegate to SDLC agents, and compile iteration status
new-project
Scaffold a new AIWG-managed project with .aiwg/ directory structure, starter CLAUDE.md, and framework registry
link-check
Verify @file references in AIWG skills and agents against the linking contract — per-file or corpus-wide, with optional auto-fix
kb-health
Lint and health-check the knowledge base. Finds orphan pages, missing cross-references, stale claims, broken wiki-links, and regenerates the index.