3 Commits

Author SHA1 Message Date
TheAuditorTool
c7a59e420b Fix: Critical Windows ProcessPoolExecutor hang and documentation drift
Fixed critical Windows compatibility issues and updated outdated documentation.

  CRITICAL WINDOWS HANG FIXES:
  1. ProcessPoolExecutor → ThreadPoolExecutor
     - Fixes PowerShell/terminal hang where Ctrl+C wouldn't work
     - Prevents .pf directory lock requiring Task Manager kill
     - Root cause: Nested ProcessPool + ThreadPool on Windows creates kernel deadlock

  2. Ctrl+C Interruption Support
     - Replaced subprocess.run with Popen+poll pattern (industry standard)
     - Poll subprocess every 100ms for interruption checking
     - Added global stop_event and signal handlers for graceful shutdown
     - Root cause: subprocess.run blocks threads with no signal propagation

  DOCUMENTATION DRIFT FIX:
  - Removed hardcoded "14 phases" references (actual is 19+ commands)
  - Updated to "multiple analysis phases" throughout all docs
  - Fixed CLI help text to be version-agnostic
  - Added missing "Summary generation" step in HOWTOUSE.md

  Changes:
  - pipelines.py: ProcessPoolExecutor → ThreadPoolExecutor, added Popen+poll pattern
  - Added signal handling and run_subprocess_with_interrupt() function
  - commands/full.py: Updated docstring to remove specific phase count
  - README.md: Changed "14 distinct phases" to "multiple analysis phases"
  - HOWTOUSE.md: Updated phase references, added missing summary step
  - CLAUDE.md & ARCHITECTURE.md: Removed hardcoded phase counts

  Impact: Critical UX fixes - Windows compatibility restored, pipeline interruptible
  Testing: Ctrl+C works, no PowerShell hangs, .pf directory deletable
2025-09-09 14:26:18 +07:00
TheAuditorTool
2a3565ad38 Clarify installation and directory structure to prevent user confusion
Updated README.md and HOWTOUSE.md with explicit directory guidance after
  multiple users reported confusion about installation process.

  Changes:
  - Split Quick Start into clear two-step process (install tool vs analyze project)
  - Added explicit warnings about which directory to use for each command
  - Added directory structure diagram showing tool vs project separation
  - Added Common Issues & Troubleshooting section with solutions for:
    - Missing .pf/manifest.json error
    - Tree-sitter not available warning
    - Installation timeout errors
    - Nested virtual environment problems
  - Emphasized NOT creating venv before installing TheAuditor
  - Added clear  and  markers for common mistakes

  This addresses user confusion about:
  - Where to install TheAuditor (tools dir, not project)
  - Where to run commands from (project dir for analysis)
  - Why nested venvs break things (don't create your own)
  - Which Python to use (system, not venv)
2025-09-08 14:58:36 +07:00
TheAuditorTool
ba5c287b02 Initial commit: TheAuditor v1.0.1 - AI-centric SAST and Code Intelligence Platform 2025-09-07 20:39:47 +07:00