codecontext status
Project status, health, and quality metrics
The enhanced status
command now provides comprehensive project overview including usage, limits, documentation health analysis, and quality scoring.This replaces the old health
and score
commands.
$ codecontext status
Basic project status and usage
$ codecontext status --health
Documentation health analysis (replaces: codecontext health)
$ codecontext status --score
Quality scoring with grades (replaces: codecontext score)
$ codecontext status --detailed
Everything combined - comprehensive report
Sample Output
Command Options
--healthNEW
Show comprehensive documentation health analysis (replaces codecontext health
)
$ codecontext status --health
--scoreNEW
Show documentation quality scoring with grades (replaces codecontext score
)
$ codecontext status --score
--detailedENHANCED
Show everything: usage, health analysis, quality scores, and improvement recommendations
$ codecontext status --detailed
--format json
Output all status information in JSON format for CI/CD integration
$ codecontext status --format json
--history
Show historical trends and changes over the past 30 days
$ codecontext status --history
Understanding Your Metrics
Documentation Health
Shows how current your documentation is:
- Up to date: Docs match current code
- Outdated: Code changed since last update
- Missing: Expected files not found
Usage Tracking
Monitor your CodeContext usage:
- Daily updates: Resets at midnight UTC
- Token usage: AI processing consumed
- Time saved: Estimated based on avg writing speed
- Coverage: Percentage of code documented
Pro Status Features
Pro users get enhanced status reporting:
Analytics Dashboard
Web dashboard with charts, trends, and insights about your documentation.
Team Insights
See documentation contributions by team member and repository.
Export Reports
Export detailed reports in PDF or CSV format for management.
API Access
Programmatic access to all metrics via REST API.
Common Use Cases
Check before committing
Ensure docs are up to date:
$ codecontext status && git commit
Monitor usage in CI/CD
Check limits before running updates:
$ codecontext status --json | jq '.usage.remaining'
Weekly reports
Review documentation health:
$ codecontext status --history --verbose
Understanding Status Messages
"Approaching daily limit"
You're close to your daily update limit. Updates will reset at midnight UTC. Consider upgrading to Pro for unlimited updates.
"Documentation coverage low"
Less than 70% of your codebase has documentation. Run codecontext update
to improve coverage.
"Trial ending soon"
Your 14-day Pro trial is ending. Run codecontext upgrade
to keep PRO features or you'll automatically switch to the FREE plan.
Integrating with Scripts
Use the JSON output for automation:
#!/bin/bash # Check if we have updates remaining REMAINING=$(codecontext status --json | jq '.usage.remaining') if [ "$REMAINING" -gt 0 ]; then echo "Updates available: $REMAINING" codecontext update else echo "Daily limit reached" exit 1 fi