Skip to content
Cortex Workstation Logo

🌌 Cortex Workstation Documentation Hub

Welcome to the central documentation command for Cortex Workstation — the ultimate, high-performance Windows NT systems optimization, digital forensics, and native file management platform.

Because this repository contains over 139 interactive tools, 62 native Windows system modules, 23 forensic analyzers, and deeply optimized multi-threaded C/Python engines, our documentation is structured strictly by audience and intent:

🛠️ The Global Repository Map

Before diving into the code, here is how the core repository directories are arranged and what they handle:

Directory Subsystem Focus Purpose & Architectural Boundary
📂 /src/cortex_unified/core Central Engine Thread pools, IPC protocols, memory barriers, process lifecycle, and configuration management.
📂 /src/cortex_unified/system_tools OS & Forensics 62 standalone Windows NT diagnostic tools (VSS, DirectStorage, MFT Slack, SRUM/BAM, BitLocker, Dev Drives).
📂 /src/cortex_unified/analyzers Deduplication 23 advanced analyzers including Perceptual Hash, Fuzzy Ssdeep, FastCDC chunking, and Czkawka algorithms.
📂 /src/NexusExplorer Native File Manager Ultra-fast VFS tabbed explorer with USN Journal change tracking, PAR2 error correction, and unbounded undo/redo.
📂 /src/cortex_unified/ui Presentation Shell 139 lazy-loaded Qt/PySide6 tool pages, HiDPI design tokens, and 145 scalable vector SVG icons.
📂 /src/cortex_unified/translations Multi-Language Real-time locale switching supporting English, German, Spanish, French, Chinese, and Japanese.
📂 /tests Automated Test Suites 1,569 automated test cases covering every tool, engine, worker thread, and GUI component.
📂 /scripts Diagnostics & Build Diagnostic verification suites (verify_production_readiness.py), PyInstaller packaging, and code audits.

🚀 1. User & Integrator Space

This space is dedicated to getting up and running quickly. It treats the project as a high-performance, turnkey workstation application.

[!TIP] Standalone Windows Executables (No Python or Rust Required): Pre-compiled standalone releases are available in GitHub Release v1.2.0: - 1-Click Setup Installer (.exe): Download Cortex-Workstation-v1.2.0-Setup.exe (Recommended - includes Start Menu, Desktop shortcuts, and uninstaller). - Portable Release (.zip): Download Cortex-Workstation-v1.2.0-Windows-x64.zip (extract anywhere and run CortexCleaner.exe). Supported on Windows 10/11 x64 and Windows 11 ARM64 (via Prism emulation).

Quick Start

  • Installation & Requirements: Standalone executables, Python 3.10–3.14 prerequisites, virtual environments, Git setup, and desktop shortcuts.
  • Configuration Engine: Complete reference of runtime parameters, safety override flags, and config files.

Real-World Recipes

🏗️ 2. Developer & Contributor Architecture

This space maps internal logic, low-level APIs, thread models, and coding conventions to help engineers build and contribute safely.

System Blueprint & Engineering Principles

Core Function & Subsystem Reference

Authoritative breakdowns of critical internal engines. Every core subsystem registers its interface here:

Subsystem Core Main Lifecycle Functions Purpose & Functionality Architectural Safety Rules
cortex_unified.core.engine scan(), clean(), cancel() Central engine coordinator managing worker pools, safety scans, and reporting. Strict non-blocking async execution; all mutations route through PathGuard.
cortex_unified.system_tools scan(), optimize(), audit() 62 standalone OS diagnostics querying Windows NT APIs, PowerShell, and registry. Read-only discovery by default; system mutations require user confirmation.
cortex_unified.analyzers find_duplicates(), hash_file() High-throughput hashing (BLAKE3, SHA-256), perceptual imaging, and CDC chunking. Zero-memory file streaming with chunk-level cancellation checkpoints.
NexusExplorer.native read_directory(), copy_batch() Fast VFS filesystem operations with USN Journal change streams. Fully transactional; every write operation logs to the undo/redo ledger.
cortex_unified.ui.premium load(), _refresh(), _run() 139 lazy-loaded presentation pages with HiDPI tokenized CSS palettes. Zero eager imports on startup; UI threads remain responsive at 60 FPS.

🤝 3. Open Source Contribution Standards

Cortex Workstation is 100% free and open-source under the MIT License. We welcome contributions from developers worldwide!

To ensure high quality across our massive codebase, please adhere to these standards: 1. Check for Duplication: Before implementing a new utility or forensic scanner, check cortex_unified/system_tools and analyzers/ to see if an existing module provides that interface. 2. Local Test Validation: Always run the test suite locally before submitting a PR: 

pytest tests/ --no-cov
python scripts/verify_production_readiness.py
3. Keep Documentation Synchronized: If your pull request introduces a new tool, updates a configuration flag, or changes a public API, update the corresponding documentation under docs/.

🆘 Troubleshooting & Community Assistance