Cmdlet

Show-ConsoleOverview

Module: ConsoleMonster
Inputs: None
Outputs: ConsoleMonster.Overview.OverviewSnapshot System.String

Shows a compact, read-only summary of the local host.

Syntax

Show-ConsoleOverview
[-AsString]
[-BudgetMilliseconds <Int32>]
[[-Section] <String[]>]
[-Width <Int32>]
[<CommonParameters>]

Parameter set: Render

Show-ConsoleOverview
[-AsObject]
[-BudgetMilliseconds <Int32>]
[[-Section] <String[]>]
[<CommonParameters>]

Parameter set: Object

Description

Collects CPU, memory, local fixed disks, network addresses and safely available services, update/reboot and security observations. Unavailable panels are hidden. Slow sections show a pending marker after the caller budget; each probe receives a two-second cooperative timeout. At 80 columns or more panels use two columns and at most 24 rows, capped at 120 columns. Below 80 columns panels stack at their natural height, preserving volumes and login rows; terminal scrolling is allowed. No elevation, child processes, remote access or system changes are used. Security data requires existing read access. Linux update and security support depends on local update-notifier and auth.log facilities; macOS optional service, update and security panels are hidden. Register application sections through OverviewSectionRegistry.Default.Register. Custom providers must honor cancellation and release their resources.

Examples

Example 1

Show-ConsoleOverview

Show the local login overview.

Example 2

$snapshot = Show-ConsoleOverview -Section Resources,Disks -AsObject

Return selected data for a script.

Example 3

Show-ConsoleOverview -Width 60 -AsString

Capture a compact plain-text overview.

Parameters

-AsString SwitchParameter optionalsets: Render: Returns one plain-text string for capture or redirection on PowerShell 5.1 and 7.
-BudgetMilliseconds Int32 optional: The caller's collection budget in milliseconds, from 1 to 900; default 750. Slow sections become pending markers. Native scheduling and rendering time are outside this waiting budget.
-Section String[] optionalposition: 0: Registry section keys, in requested order. Built-ins: Resources, Disks, Network, Services, Updates, Security. Omit to collect all registered sections. Unknown keys produce an error.
-Width Int32 optionalsets: Render: Layout width in cells, capped at 120; zero uses the terminal width.
-AsObject SwitchParameter optionalsets: Object: Returns the immutable OverviewSnapshot instead of drawing it.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.