health-check

Run comprehensive health checks on software projects for code quality, documentation gaps, and Git hygiene issues.

Updated Oct 11, 2025
One-click install
npx skills add https://github.com/tnez/docent --skill health-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: health-check
Source: https://github.com/tnez/docent/tree/main/skills/development/health-check
Command: npx skills add https://github.com/tnez/docent --skill health-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git cli, ripgrep.

What problem does it solve?

Over time, codebases can accumulate technical debt, debug code, broken links, and uncommitted changes, leading to instability and reduced quality. This Skill performs a comprehensive health check, identifying potential issues across code quality, documentation, and git hygiene, ensuring your project remains clean and release-ready.

Core Features & Use Cases

  • Code Quality Scan: Detects debug code (console.log, debugger), test markers (.only, .skip), and temporary files.
  • Documentation Validation: Checks for broken internal links and assesses documentation completeness.
  • Git Hygiene Audit: Identifies uncommitted changes, untracked files, and temporary artifacts.
  • Use Case: Before a major release, run this Skill to get a detailed report on your project's health. It will flag any forgotten console.log statements, ensure all documentation links are valid, and confirm your git repository is clean, preventing last-minute surprises.

Quick Start

Run a comprehensive health check on this project.

Frequently Asked Questions about health-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check for debug code and test markers before releasing?▼

Health checks scan your codebase for leftover debug statements like console.log and debugger, plus test markers like .only and .skip. Run the check before releases to catch these issues automatically and prevent them from reaching production.

Can I validate documentation links across my project automatically?▼

Yes, health checks assess documentation completeness and detect broken internal links across your project. This catches outdated or missing documentation references without manual review.

What does a Git hygiene audit catch?▼

A Git hygiene audit identifies uncommitted changes, untracked files, and temporary artifacts in your repository. This ensures your project state is clean and release-ready before major commits or deployments.

How do I remove technical debt and stray files from my codebase?▼

Health checks flag temporary files, debug code, and structural misalignments across your project. The detailed report lets you systematically clean up technical debt and prepare for stable releases.

Do I need Git and ripgrep installed to run health checks?▼

Yes, health checks require Git CLI and ripgrep as dependencies. These tools enable comprehensive scanning of your repository state and code patterns across files.

When should I run project health checks?▼

Run health checks before major releases, significant commits, or whenever you want to audit code quality, documentation gaps, and repository cleanliness. This prevents last-minute surprises and ensures consistent project standards.