Restructure project documentation with clear separation of concerns

- README.md: Reference manual with detailed script functionality - QUICKSTART.md: Practical guide for installation, configuration, and troubleshooting - SUMMARY.md: Design rationale and architectural decisions Each document serves distinct user needs without overlap. Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
2026-04-27 11:02:06 +08:00
parent cbd90b0369
commit c1d69b02ed
3 changed files with 739 additions and 14 deletions
--- a/README.md
+++ b/README.md
@@ -1,22 +1,207 @@
 # Windows Remote Toolkit

-A comprehensive remote management toolkit for configuring and managing Windows machines from macOS/Linux systems.
+A comprehensive remote management toolkit for configuring and managing Windows machines from macOS/Linux systems via SSH and WinRM.

-## Overview
+## 🛠️ 腳本功能參考

-This toolkit provides automated scripts for system debloating, application installation, security configuration, and diagnostics on remote Windows machines via SSH and WinRM.
-
-## Quick Start
+### 系統配置類

+#### `activate-windows.sh`
+透過 KMS 啟用 Windows 授權
 ```bash
-# Enable SSH access
-./firewall-allow-ssh.sh
-
-# System reconnaissance
-./recon.sh
-
-# Remove Windows AI components
-./remove-windows-ai.sh
+./scripts/ssh/activate-windows.sh
 ```

-See [CLAUDE.md](CLAUDE.md) for detailed documentation and usage instructions.
+#### `firewall-allow-ssh.sh`
+在 Windows 防火牆中建立永久的 SSH 存取規則
+```bash
+./scripts/ssh/firewall-allow-ssh.sh
+```
+- 建立跨所有防火牆設定檔的入站規則
+- 確保重啟後 SSH 連線仍可用
+
+#### `win11debloat.sh`
+執行 Win11Debloat 腳本移除膨脹軟體並停用遙測
+```bash
+./scripts/ssh/win11debloat.sh
+```
+- 使用 `config/win11debloat-config.json` 配置
+- 支援 `MODE=Apply|Revert` 環境變數
+
+#### `remove-windows-ai.sh`
+移除 Windows AI/Copilot 組件
+```bash
+./scripts/ssh/remove-windows-ai.sh
+MODE=Apply ./scripts/ssh/remove-windows-ai.sh    # 套用移除
+MODE=Revert ./scripts/ssh/remove-windows-ai.sh   # 還原變更
+```
+
+### 連線管理類
+
+#### `enable-winrm.sh`
+配置 WinRM 服務用於快速連線
+```bash
+./scripts/ssh/enable-winrm.sh
+```
+
+#### `test-winrm-connection.sh`
+測試 WinRM 連線狀態
+```bash
+./scripts/ssh/test-winrm-connection.sh
+```
+
+#### `check-winrm.sh`
+檢查 WinRM 服務配置
+```bash
+./scripts/ssh/check-winrm.sh
+```
+
+### 應用程式管理類
+
+#### `install-apps.sh`
+批次安裝常用應用程式
+```bash
+./scripts/ssh/install-apps.sh
+```
+
+#### `remove-apps.sh`
+批次移除指定應用程式
+```bash
+./scripts/ssh/remove-apps.sh
+```
+- 使用 `config/remove-apps-config.json` 配置
+
+#### `install-thunderbird.sh`
+安裝 Mozilla Thunderbird
+```bash
+./scripts/ssh/install-thunderbird.sh
+```
+
+#### `setup-thunderbird.sh`
+配置 Thunderbird 電子郵件帳戶
+```bash
+./scripts/ssh/setup-thunderbird.sh
+```
+- 使用 `config/thunderbird-config.json` 配置
+- 支援多種電子郵件提供商
+
+#### `install-telegram.sh`
+安裝 Telegram Desktop（per-user 安裝）
+```bash
+./scripts/ssh/install-telegram.sh
+```
+
+#### `install-nirsoft.sh`
+安裝 NirSoft 診斷工具集
+```bash
+./scripts/ssh/install-nirsoft.sh
+```
+
+#### `install-cports.sh`
+安裝 CurrPorts 網路連線監控工具
+```bash
+./scripts/ssh/install-cports.sh
+```
+
+### 診斷類
+
+#### `recon.sh`
+完整系統偵察（15 個資訊區塊）
+```bash
+./scripts/ssh/recon.sh
+```
+- 硬體資訊、網路配置、軟體清單等
+- 輸出儲存到 `logs/` 目錄
+
+#### `nirsoft-dump.sh`
+使用 NirSoft 工具進行系統診斷並打包結果
+```bash
+./scripts/ssh/nirsoft-dump.sh
+```
+- 輸出 ZIP 檔案到 `dumps/` 目錄
+
+#### `verify-debloat.sh`
+驗證 Win11Debloat 變更是否已套用
+```bash
+./scripts/ssh/verify-debloat.sh
+```
+
+#### `verify-ai-removed.sh`
+驗證 Windows AI 組件是否已移除
+```bash
+./scripts/ssh/verify-ai-removed.sh
+```
+
+### 使用者管理類
+
+#### `rename-hide-accounts.sh`
+重新命名或隱藏系統帳戶
+```bash
+./scripts/ssh/rename-hide-accounts.sh
+```
+- **⚠️ 風險操作**：建議最後執行
+
+#### `apply-ui-to-user.sh`
+將 UI 設定套用到指定使用者
+```bash
+TARGET_USER=username ./scripts/ssh/apply-ui-to-user.sh
+```
+
+### 輸入法配置
+
+#### `configure-ime.sh`
+配置中文輸入法設定
+```bash
+./scripts/ssh/configure-ime.sh
+```
+
+## 🚀 快速執行包裝器
+
+### SSH 方法（預設）
+```bash
+./ssh_run.sh <script.ps1>           # 執行單一 PowerShell 腳本
+```
+
+### WinRM 方法（更快）
+```bash
+./winrm_run.sh <script.ps1>         # WinRM 執行
+python3 scripts/winrm/smart_executor.py <script.ps1>  # 智慧選擇連線方法
+```
+
+## ⚙️ 環境變數覆寫
+
+所有腳本支援連線參數覆寫：
+```bash
+HOST=192.168.x.x USER_NAME=admin PASS='secret' ./scripts/ssh/recon.sh
+MODE=Apply ./scripts/ssh/remove-windows-ai.sh
+TARGET_USER=someone ./scripts/ssh/apply-ui-to-user.sh
+```
+
+## 📋 配置檔案
+
+| 檔案 | 用途 |
+|------|------|
+| `config/win11debloat-config.json` | Win11Debloat 操作設定 |
+| `config/thunderbird-config.json` | 電子郵件帳戶配置 |
+| `config/remove-apps-config.json` | 應用程式移除清單 |
+| `config/nirsoft-config.json` | NirSoft 工具下載設定 |
+
+## 📁 輸出目錄
+
+- `logs/` - 執行日誌（帶時間戳）
+- `dumps/` - 診斷資料 ZIP 檔案
+
+## 🎯 預設連線目標
+
+- **主機**：`192.168.88.112` (PC-74269)
+- **使用者**：`Admin`
+- **密碼**：`P@ssw0rd!`
+
+可透過環境變數覆寫連線參數。
+
+---
+
+更多詳細資訊請參考：
+- [QUICKSTART.md](QUICKSTART.md) - 安裝與操作指南
+- [SUMMARY.md](SUMMARY.md) - 設計理念與架構說明
+- [CLAUDE.md](CLAUDE.md) - 完整技術文檔