Documentation Index
Fetch the complete documentation index at: https://docs.aitmpl.com/llms.txt
Use this file to discover all available pages before exploring further.
Health Check
The health check command performs comprehensive verification of your Claude Code installation, configuration, and project setup.Run Health Check
Basic Usage
Run the health check:Interactive Flow
The health check:- Runs all verification tests
- Displays results in real-time
- Generates health score
- Provides recommendations
- Optionally launches project setup
Health Check Categories
The health check verifies seven categories:1. System Requirements
Verifies your development environment: Operating System:- Platform: macOS, Linux, or Windows
- Version: Compatible release
- Status: ✅ Pass / ❌ Fail
- Required: Node.js 18+
- Current version check
- Compatibility verification
- Recommended: 4GB+ total memory
- Current memory status
- Free memory available
- Anthropic API connectivity
- Response time check
- Network accessibility
- Shell type (bash, zsh, fish)
- Autocompletion support
- Compatibility status
2. Claude Code Setup
Verifies Claude installation: Installation:- Claude Code CLI presence
- Version information
- Global/local installation
- OAuth account check
- API key verification
- Environment variable check
- Update settings
- Version currency
- Directory permissions
- Write access
- Configuration access
3. Project Setup
Verifies project configuration: Project Structure:- Project indicators (package.json, etc.)
- Directory structure
- Project type detection
.claude/directory existence- File count and structure
- Configuration validity
~/.claude/settings.json- Settings structure
- Permission rules
- Environment variables
.claude/settings.json- Project-specific configuration
- Hook definitions
- MCP server lists
.claude/settings.local.json- Local overrides
- Developer-specific config
4. Agents
Verifies installed agents: Project Agents:.claude/agents/directory- Agent file count
- Recursive directory scan
~/.claude/agents/directory- Global agent count
- Agent availability
- YAML frontmatter validation
- Required fields (name, description)
- Proper markdown structure
5. MCP Servers
Verifies MCP configuration: Project MCP Config:.mcp.jsonexistence- Server count
- Configuration validity
- JSON validity
- Required fields (command)
- Args and env format
- Server configuration completeness
6. Custom Commands
Verifies slash commands: Project Commands:.claude/commands/directory- Command count
- File structure
~/.claude/commands/directory- Global command count
- Markdown structure
$ARGUMENTSplaceholder- Proper formatting
7. Hooks Configuration
Verifies automation hooks: User Hooks:~/.claude/settings.jsonhooks- Hook count and types
.claude/settings.jsonhooks- Project-specific automation
.claude/settings.local.jsonhooks- Developer-specific hooks
- Command executability
- Shell builtin recognition
- Command availability verification
- MCP-specific hook validation
- Integration checks
Health Check Output
Real-Time Display
As checks run:Health Score
Final summary:Status Icons
- ✅ Pass: Check passed, no issues
- ⚠️ Warn: Check passed with warnings
- ❌ Fail: Check failed, needs attention
Health Check Recommendations
Based on results, the health check suggests:System Issues
Low Memory:Configuration Issues
Missing Frontmatter:After Health Check
Setup Recommendation
If health score is low (below 80%), the CLI prompts:Manual Fixes
For specific issues, fix manually:Use Cases
1. Initial Setup Verification
2. Troubleshooting
3. Team Onboarding
4. Pre-Deployment
5. Regular Maintenance
Troubleshooting
Health Check Hangs
Network timeout:- Check internet connection
- Verify Anthropic API access
- Use
Ctrl+Cto cancel
- Check
.claude/permissions - Verify disk space
- Close other applications
False Negatives
Claude CLI not detected:Performance Issues
Slow health check:- Large conversation history
- Many agents/commands
- Network latency
Health Check Options
Run comprehensive health check
Short alias for —health-check
Alternative alias for —health-check
Another alias for —health-check
Best Practices
Regular Checks
Run health checks:- After installation
- Before major updates
- Monthly maintenance
- When troubleshooting
- Team onboarding
Documentation
Document health scores:Team Standards
Set minimum health score:Automation
Automate health checks:Advanced Usage
Custom Health Checks
Extend with custom validations:Health Check API
Programmatic access:Next Steps
- CLI Overview - Complete CLI documentation
- Configuration Guide - Settings and config files
- Analytics Dashboard - Monitor Claude Code usage
- Environment Variables - Configure authentication