# Installation [[Home]] › Installation RDP-Tool is a **single self-contained script** - there is nothing to install, no modules, no MSI. --- ## ✅ Prerequisites | Requirement | Notes | |---|---| | Windows 10 / 11 / Server 2016+ | The tool drives Windows-only APIs (registry, CIM/WMI, NetSecurity, WTS) | | **PowerShell 7+** (`pwsh`) | Enforced via `#Requires -Version 7.0`. Install: `winget install Microsoft.PowerShell` | | Administrator rights | Only for **changes** (`-EnableRDP`, `-SetPort`, `-AddUser`, ...). Read-only diagnostics work unelevated | | Internet access | Only for `-CheckUpdate` / `-Update` / `-TestExternal` (or use an internal mirror via `-UpdateSource`) | --- ## 📥 Getting the Tool ### Option A - Git ```powershell git clone https://github.com/paulmann/RDP-Diagnostic-Tool cd RDP-Diagnostic-Tool pwsh -NoProfile -File .\RDP-Tool.ps1 -Help ``` ### Option B - Release download Download `RDP-Tool.ps1` from the [latest release](https://github.com/paulmann/RDP-Diagnostic-Tool/releases/latest), then unblock it once: ```powershell Unblock-File .\RDP-Tool.ps1 ``` ### Option C - One-liner (dot-source into a session) ```powershell # From a trusted network location or after reviewing the file: . .\RDP-Tool.ps1 -Help ``` ### Option D - npm (Node.js 18+) The same `RDP-Tool.ps1` is published to npm as `rdp-diagnostic-tool`. It is the script plus a launcher that resolves `pwsh` and forwards the tool's exit codes. ```powershell npx rdp-diagnostic-tool@5.0.1 -Version # try without installing npm install -g rdp-diagnostic-tool # permanent: rdp-tool on PATH rdp-tool # full read-only audit ``` Full details, update and uninstall instructions: see `docs/NPM.md` in the repository. ### Option E - winget / Scoop ```powershell # winget (after the manifest is merged into microsoft/winget-pkgs) winget install Paulmann.RDPDiagnosticTool # Scoop, straight from the repository manifest scoop install https://raw.githubusercontent.com/paulmann/RDP-Diagnostic-Tool/main/scoop/rdp-diagnostic-tool.json ``` Both place a shim on `PATH` under the name `rdp-tool`. ### Execution policy If your policy blocks scripts, invoking through `pwsh -File` (as shown above) is the cleanest per-invocation bypass. Alternatives: ```powershell Set-ExecutionPolicy -Scope Process Bypass # current window only # or sign the script and require signatures: # Get-AuthenticodeSignature .\RDP-Tool.ps1 ``` > [!TIP] > For enterprise deployment, mirror `RDP-Tool.ps1` to an internal share and > distribute via SCCM/Intune. Pin updates with `-UpdateSource `. --- ## 🔄 Updating The tool updates itself from GitHub Releases (validated + backed up + atomic replace): ```powershell .\RDP-Tool.ps1 -CheckUpdate # 0 = up to date, 5 = update available, 6 = check failed .\RDP-Tool.ps1 -Update # interactive .\RDP-Tool.ps1 -Update -Force # unattended (backup: RDP-Tool.ps1.bak-) ``` Air-gapped / mirrored environments: ```powershell .\RDP-Tool.ps1 -Update -UpdateSource https://intranet.corp/tools/RDP-Tool.ps1 .\RDP-Tool.ps1 -Update -UpdateSource contoso/RDP-Diagnostic-Tool # fork slug ``` What `-Update` guarantees: 1. TLS-only download (GitHub API → release asset → tagged raw file → branch raw file) 2. Content validation: size floor, HTML-error-page detection, embedded version marker match, **full PowerShell syntax parse** 3. Timestamped backup next to the script (falls back to `%TEMP%` if the folder is write-protected) 4. Atomic replacement (temp file + move) - the old file is never left half-written --- ## 🗑️ Uninstalling Delete `RDP-Tool.ps1` (and any `.bak-*` backups). The tool writes nothing to the registry or disk except the reports/logs **you** request via `-ExportReport`, `-ExportJson`, `-LogPath`. If it was installed through a package manager, remove it there instead: ```powershell npm uninstall -g rdp-diagnostic-tool winget uninstall Paulmann.RDPDiagnosticTool scoop uninstall rdp-diagnostic-tool ``` --- Next: [[Usage]] for the CLI reference.