Skip to content

Add Avalonia UI GUI launcher for System Resources As Built Report #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 3 commits into
base: dev
Choose a base branch
from
Draft

Add Avalonia UI GUI launcher for System Resources As Built Report #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fb369e
Initial plan
Copilot Mar 11, 2026
be03e40
Add Avalonia UI GUI launcher for System Resources As Built Report
Copilot Mar 11, 2026
3a4f1e5
Refactor code formatting and improve readability in Invoke-AsBuiltRep…
rebelinux Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AsBuiltReport.System.Resources.psd1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @('Invoke-AsBuiltReport.System.Resources')
FunctionsToExport = @('Invoke-AsBuiltReport.System.Resources', 'Start-AsBuiltReportGui')

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
# CmdletsToExport = @()
Expand Down
47 changes: 47 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,53 @@ The **Healthcheck** schema is used to toggle health checks on or off.

No health checks are currently available for this report.

## :desktop_computer: Graphical User Interface (GUI)

A cross-platform graphical launcher is included in the module. It is powered by
[AvaloniaUIShell](https://github.com/mdgrs-mei/AvaloniaUIShell) and requires
**PowerShell 7.4 or newer**.

### GUI Requirements

| Requirement | Version |
| ----------- | ------- |
| PowerShell | 7.4+ |
| AvaloniaUIShell | latest |

### Installing AvaloniaUIShell

```powershell
# Install the AvaloniaUIShell module
Install-PSResource -Name AvaloniaUIShell

# macOS / Linux only – add execute permission to the server binary:
Enable-AUIExecution
```

### Launching the GUI

```powershell
# Option A – via the exported module function (recommended):
Import-Module AsBuiltReport.System.Resources
Start-AsBuiltReportGui

# Option B – run the script directly:
& "$((Get-Module AsBuiltReport.System.Resources).ModuleBase)\Src\GUI\Invoke-AsBuiltReportGui.ps1"
```

The GUI window lets you configure every common report parameter through a
point-and-click interface:

| Section | Controls |
| ------- | -------- |
| **Report Configuration** | Target, Output Folder (with folder browser), Report Name, Language |
| **Output Formats** | HTML · Word · Text · Excel checkboxes |
| **Options** | Timestamp · HealthCheck · Enable Diagrams · Export Diagrams · Diagram Theme |
| **Info Level** | Per-section selectors (0 = Disabled, 1 = Summary, 2 = Detailed) for Date, TimeZone, Uptime, PSHost, ProcessInfo |
| **Generate** | Progress bar · scrollable log showing live output |

Report generation runs on a background thread so the window stays fully responsive.

## :computer: Examples

The following examples demonstrate how to generate a System Resources As Built Report.
Expand Down
Loading