Skip to main content

Advanced productivity tracking and context optimization for AI-assisted development

Project description

Context Cleaner

PyPI version Python Support License: MIT

Advanced productivity tracking and context optimization for AI-assisted development

Context Cleaner is a comprehensive productivity tracking tool designed specifically for developers using AI coding assistants like Claude Code. It provides intelligent context health monitoring, performance analytics, and optimization recommendations to maximize development productivity.

๐ŸŽฏ Key Features

๐Ÿ“Š Effectiveness Tracking & Analytics โญ NEW in v0.2.0

  • Before/after metrics with quantifiable productivity improvements
  • User satisfaction tracking with 1-5 rating system and feedback collection
  • Strategy effectiveness analysis across Conservative/Balanced/Aggressive/Focus modes
  • ROI demonstration with time-saved calculations and optimization impact
  • Export capabilities for comprehensive analytics data backup and analysis

๐Ÿ” Advanced Context Optimization

  • Multi-strategy optimization with Conservative, Balanced, Aggressive, and Focus modes
  • Context health scoring (0-100 scale) based on size, structure, and complexity
  • Interactive optimization with operation approval/rejection workflow
  • Performance correlation analysis between context optimization and productivity
  • Real-time context monitoring with automatic boundary detection

๐Ÿ“ˆ Unified Dashboard Hub

  • Comprehensive web interface with integrated telemetry, orchestration, analytics, and performance monitoring
  • Tabbed navigation providing Overview, Telemetry, Orchestration, Analytics, and Performance views in one place
  • Real-time dynamic data from live telemetry systems with comprehensive legends explaining all metrics
  • ML-powered insights with optimization recommendations and workflow performance analysis
  • Single entry point - all features accessible through one dashboard interface

๐Ÿ›ก๏ธ Privacy-First Architecture

  • Local-only processing - all data stays on your machine
  • PII sanitization - automatic removal of emails, SSNs, credentials, and sensitive data
  • Secure file storage with atomic operations and file locking
  • Complete data ownership with easy export and deletion
  • Transparent operation with open-source codebase

๐Ÿ”ง Developer-Friendly CLI

  • Comprehensive command set with 15+ commands for all productivity needs
  • Multiple output formats (JSON, text) for integration and automation
  • Session management with start/end tracking and detailed analytics
  • System health monitoring with diagnostics and issue resolution
  • Flexible configuration via files, environment variables, or CLI flags

๐Ÿš€ Quick Start

Installation

# Install from PyPI
pip install context-cleaner

# Or install from source
git clone https://github.com/context-cleaner/context-cleaner.git
cd context-cleaner
pip install -e .

Telemetry Setup (Recommended)

# Provision local ClickHouse + OpenTelemetry stack
context-cleaner telemetry init

# Load telemetry environment variables (bash/zsh)
source ~/.context_cleaner/telemetry/telemetry-env.sh

Docker Required: Telemetry features rely on Docker and Docker Compose. Install Docker Desktop (macOS/Windows) or Docker Engine (Linux) and ensure it is running before initialising telemetry.

Windows PowerShell: Import the environment variables after telemetry init:

Get-Content "$env:USERPROFILE\.context_cleaner\telemetry\telemetry-env.sh" |
  ForEach-Object {
    if ($_ -match '^export\s+(\w+)=(.+)$') {
      Set-Item -Path Env:$($matches[1]) -Value $matches[2].Trim('"')
    }
  }

Then restart Claude Code or your terminal so the variables take effect.

Unified Dashboard Access ๐ŸŽฏ

# Launch the comprehensive dashboard with full orchestration (recommended)
context-cleaner run

# Example: override the dashboard port
context-cleaner run --dashboard-port 8110

The unified dashboard provides everything in one place:

  • ๐Ÿ“Š Overview: Key metrics and system summary
  • ๐Ÿ“ˆ Telemetry: Real-time monitoring with Phase 1-3 widgets
  • ๐Ÿค– Orchestration: ML-powered workflow coordination and agent utilization
  • ๐Ÿ” Analytics: Context health and performance trends with detailed legends
  • โšก Performance: Real-time system resources, database, and cache metrics

Dashboard URL: http://localhost:8081

Command Line Tools (Optional)

# Frequently used CLI commands
context-cleaner run --status-only --json   # Snapshot orchestrator health
context-cleaner health-check               # System diagnostics
context-cleaner effectiveness --days 7     # Optimization stats
context-cleaner stop                       # Graceful shutdown

๐Ÿ“Š New Analytics Features โญ

Effectiveness Tracking

# View optimization effectiveness stats
context-cleaner effectiveness --days 30

# Example output:
# ๐Ÿ“ˆ OPTIMIZATION EFFECTIVENESS REPORT
# ====================================
# ๐Ÿ“… Analysis Period: Last 30 days
# ๐ŸŽฏ Total Optimization Sessions: 45
# โšก Success Rate: 89.3%
# ๐Ÿ’ฐ Estimated Time Saved: 12.5 hours
# ๐Ÿ“Š Average Productivity Improvement: +23.4%
# ๐ŸŒŸ User Satisfaction: 4.2/5.0
# 
# ๐Ÿ’ก TOP STRATEGIES:
#    1. Balanced Mode: 67% of sessions, 4.3/5 satisfaction
#    2. Focus Mode: 22% of sessions, 4.5/5 satisfaction  
#    3. Aggressive Mode: 11% of sessions, 3.8/5 satisfaction

Comprehensive Analytics Export

# Export all analytics data
context-cleaner export-analytics --days 90 --output analytics-backup.json

# Export with session details
context-cleaner export-analytics --include-sessions --output detailed-report.json

System Health Monitoring

# Basic health check
context-cleaner health-check

# Detailed diagnostics
context-cleaner health-check --detailed

# Auto-fix common issues
context-cleaner health-check --fix-issues

# JSON output for automation
context-cleaner health-check --format json

๐Ÿ“š Complete CLI Reference

Core Commands

context-cleaner [OPTIONS] COMMAND [ARGS]...

# Orchestration & Telemetry:
  run                      Orchestrate services and launch the dashboard
  stop                     Gracefully shut down orchestrated services
  telemetry init           Provision ClickHouse/OTEL stack from packaged assets

# Analytics & Health:
  health-check             Perform system health diagnostics
  effectiveness            Display optimization effectiveness statistics
  export-analytics         Export analytics data for archival/analysis

# Session Management:
  session start            Begin tracking a development session
  session end              End the current session
  session stats            Show session statistics for a time window
  session list             List recent sessions

# File/Directory Monitoring:
  monitor start            Begin real-time context monitoring
  monitor status           Show monitoring status
  monitor live             Stream live metrics in the terminal

# Data & Configuration:
  analyze                  Analyze productivity trends
  export                   Export all recorded data
  privacy                  Manage privacy and data retention
  config-show              Show current configuration values

Session Management Examples

# Start named session for specific project
context-cleaner session start --session-id "api-refactor" --project-path ./my-project

# View session statistics
context-cleaner session stats --days 7

# List recent sessions
context-cleaner session list --limit 10

# End current session
context-cleaner session end

Advanced Monitoring

# Start real-time monitoring
context-cleaner monitor start --watch-dirs ./src --watch-dirs ./tests

# Check monitoring status
context-cleaner monitor status

# Launch live console dashboard with 10-second refresh
context-cleaner monitor live --refresh 10

๐Ÿ“ˆ Dashboard Features

Enhanced Analytics Dashboard

  • Effectiveness Overview - Success rates, time saved, and ROI metrics
  • Strategy Performance - Comparative analysis of optimization approaches
  • User Satisfaction Trends - Rating patterns and feedback analysis
  • Before/After Comparisons - Quantifiable productivity improvements
  • Interactive Controls - Operation triggers and real-time adjustments

Productivity Metrics

  • Current productivity score with 7-day trend analysis
  • Session statistics including count, duration, and effectiveness
  • Optimization events with detailed success/failure tracking
  • Health trend indicators showing improvement/decline patterns
  • Time-series charts with productivity correlation analysis

Actionable Insights

  • Personalized recommendations based on effectiveness data
  • Optimal strategy suggestions for different context types
  • Performance alerts when productivity patterns change
  • ROI calculations demonstrating Context Cleaner's value

๐Ÿ”ง Configuration

Configuration File (~/.context_cleaner/config.yaml)

# Analysis Configuration
analysis:
  health_thresholds:
    excellent: 90
    good: 70
    fair: 50
  max_context_size: 100000
  token_estimation_factor: 0.25
  circuit_breaker_threshold: 5

# Dashboard Configuration  
dashboard:
  port: 8110
  host: localhost
  auto_refresh: true
  cache_duration: 300
  max_concurrent_users: 10

# Effectiveness Tracking (NEW)
tracking:
  enabled: true
  sampling_rate: 1.0
  session_timeout_minutes: 30
  data_retention_days: 90
  anonymize_data: true

# Privacy & Security (ENHANCED)
privacy:
  local_only: true
  encrypt_storage: true
  auto_cleanup_days: 90
  require_consent: true

# Data Directory
data_directory: "~/.context_cleaner/data"
log_level: "INFO"

Environment Variables

export CONTEXT_CLEANER_PORT=8080
export CONTEXT_CLEANER_HOST=localhost
export CONTEXT_CLEANER_DATA_DIR=~/my-context-data
export CONTEXT_CLEANER_LOG_LEVEL=DEBUG
export CONTEXT_CLEANER_LOCAL_ONLY=true

๐Ÿ”’ Privacy & Security

Enhanced Security Features โญ NEW

  • PII Sanitization: Automatic removal of emails, SSNs, credit cards, and credentials
  • Content Hashing: Secure data integrity without storing raw content
  • Atomic File Operations: Race-condition protection with file locking
  • Secure Permissions: All data files use 0o600 permissions (owner-only access)
  • Input Validation: Comprehensive sanitization and size limits

Data Protection

  • Local Storage: All data in ~/.context_cleaner/data/ with secure permissions
  • No Telemetry: Zero external network requests or data transmission
  • At-Rest Encryption: Optional AES-256 encryption for sensitive data
  • Data Retention: Configurable automatic cleanup after specified period
  • Resource Limits: Built-in protection against resource exhaustion

Privacy Controls

# View privacy information
context-cleaner privacy show-info

# Export all your data
context-cleaner export --format json --output my-data.json

# Permanently delete all data
context-cleaner privacy delete-all

๐Ÿ—๏ธ Architecture

Core Components

Context Cleaner v0.2.0 Architecture
โ”œโ”€โ”€ ๐Ÿ“Š Analytics Engine (ENHANCED)
โ”‚   โ”œโ”€โ”€ ProductivityAnalyzer - Core analysis algorithms  
โ”‚   โ”œโ”€โ”€ EffectivenessTracker - Before/after metrics & ROI
โ”‚   โ”œโ”€โ”€ TrendCalculator - Time-series analysis
โ”‚   โ””โ”€โ”€ CrossSessionAnalytics - Multi-session insights
โ”œโ”€โ”€ ๐Ÿ“ˆ Dashboard System (ENHANCED)
โ”‚   โ”œโ”€โ”€ Web Server - FastAPI-based interface
โ”‚   โ”œโ”€โ”€ Data Visualization - Interactive charts & effectiveness
โ”‚   โ”œโ”€โ”€ Real-time Updates - Live metric streaming
โ”‚   โ””โ”€โ”€ Enhanced Controls - Operation triggers & analytics
โ”œโ”€โ”€ ๐Ÿ—ƒ๏ธ Data Management (SECURED)
โ”‚   โ”œโ”€โ”€ Session Tracking - Development session boundaries
โ”‚   โ”œโ”€โ”€ Secure Storage - Atomic operations & file locking
โ”‚   โ”œโ”€โ”€ PII Sanitization - Automated sensitive data removal
โ”‚   โ””โ”€โ”€ Privacy Controls - Data export/deletion with encryption
โ””โ”€โ”€ ๐Ÿ”ง CLI Interface (EXPANDED)
    โ”œโ”€โ”€ Command Processing - 15+ commands with validation
    โ”œโ”€โ”€ Output Formatting - JSON/text formats for automation
    โ”œโ”€โ”€ Session Management - Start/end/stats tracking
    โ””โ”€โ”€ Health Monitoring - System diagnostics & auto-repair

๐Ÿงช Development

Development Setup

# Clone repository
git clone https://github.com/context-cleaner/context-cleaner.git
cd context-cleaner

# Install development dependencies
pip install -e .[dev]

# Run full test suite (146 tests)
pytest

# Run specific test categories
pytest -m unit           # Unit tests only
pytest -m integration    # Integration tests only  
pytest -m security       # Security tests (NEW)

# Code quality
black src/ tests/
flake8 src/ tests/
mypy src/

Testing

# Full test suite with coverage
pytest --cov=context_cleaner --cov-report=html

# Test new analytics features
pytest tests/cli/test_pr20_analytics_integration.py -v

# Security and performance tests
pytest tests/cli/test_pr20_analytics_integration.py::TestSecurityAndPerformanceFixes -v

๐Ÿ“„ What's New in v0.2.0

๐Ÿ”ฅ Major Features

  • Effectiveness Tracking System: Quantifiable before/after productivity metrics
  • User Satisfaction Monitoring: Rating system with feedback collection
  • Strategy Analysis: Performance comparison across optimization modes
  • ROI Demonstration: Time-saved calculations and productivity improvements
  • Enhanced CLI: 3 new commands (health-check, export-analytics, effectiveness)

๐Ÿ›ก๏ธ Security Improvements

  • PII Sanitization: Automatic sensitive data removal before storage
  • Atomic File Operations: Race-condition prevention with exclusive locking
  • Secure Storage: Enhanced file permissions and data integrity protection
  • Content Hashing: Secure data handling without raw content storage

โšก Performance Optimizations

  • Session Indexing: O(1) lookups instead of O(n) file scans
  • LRU Caching: Optimized frequent data access patterns
  • Optimized I/O: Index-based filtering and reduced file operations
  • Memory Management: Efficient resource usage and cleanup

๐Ÿงช Production Readiness

  • Enhanced Error Handling: Consistent exception management without sys.exit()
  • Comprehensive Testing: 29 tests including security and performance validation
  • Resource Management: Proper cleanup and context manager usage
  • Documentation: Complete overhaul with accurate examples and guides

๐Ÿค Support

Documentation

Community

๐ŸŽฏ Roadmap

Version 0.3.0 (Next Release)

  • Machine Learning Analytics: AI-powered productivity insights and forecasting
  • Team Collaboration: Aggregated (anonymized) team productivity metrics
  • IDE Integration: Direct integration with popular development environments
  • Advanced Visualizations: Enhanced charts and productivity correlation analysis

Future Versions

  • Cross-Project Analytics: Multi-repository productivity tracking
  • Custom Metrics: User-defined productivity indicators and thresholds
  • API Integration: Webhooks and external service connectivity
  • Performance Benchmarking: Industry-wide anonymous productivity comparisons

Context Cleaner v0.2.0 - Transforming AI-assisted development through intelligent productivity tracking, effectiveness measurement, and optimization.

Built with โค๏ธ for developers who want to understand and improve their coding productivity.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

context_cleaner-0.3.0.tar.gz (869.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

context_cleaner-0.3.0-py3-none-any.whl (993.7 kB view details)

Uploaded Python 3

File details

Details for the file context_cleaner-0.3.0.tar.gz.

File metadata

  • Download URL: context_cleaner-0.3.0.tar.gz
  • Upload date:
  • Size: 869.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for context_cleaner-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fdaeaae0c6d2efb1bfaf37a018670b2b990d914955bd0a6a67b3b4dd1ee154cf
MD5 b611cfd63a44152247fd6c94b7cca21c
BLAKE2b-256 57147b9910d49f25223814d71d0f3d808d0db921102d50090b17509fef5033e6

See more details on using hashes here.

File details

Details for the file context_cleaner-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for context_cleaner-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 97b25440ab2649d944fe1fcc75e98e5c56cc506f4c2de7c9561f0cebd04f6251
MD5 77789afa1157047b78a758df9a3a8dd0
BLAKE2b-256 7da8e19030da1b7f3041913238de19dba3e8aacf8fe5c8213af57ce7511b31af

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page