Cmdlet

Show-ConsoleObject

Module: ConsoleMonster
Inputs: System.Management.Automation.PSObject
Outputs: System.Object System.String

Explores an object's members with the keyboard.

Syntax

Show-ConsoleObject
[-Depth <Int32>]
[-Exclude <String[]>]
[-Include <String[]>]
-InputObject <PSObject>
[-MaxItems <Int32>]
[-MaxNodes <Int32>]
[-Mode <Rich|Line|Accessible>]
[[-Output] <Value|Path>]
[-PassThru]
[-RootPath <String>]
[-Title <String>]
[-Width <Int32>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Arrows move, Right and Left expand and collapse, Enter drills into a member, Backspace returns to its parent, and / searches displayed names and values. Ctrl+Enter or F10 accepts the selected node; Esc cancels. Nested values are read lazily and cycles, depth and collection sizes are bounded. In redirected, CI, line and non-interactive sessions, a static inspector is printed and no selection is returned. Objects parsed by ConvertFrom-Json use the same PowerShell member adapter as other objects.

Examples

Example 1

$config | Show-ConsoleObject

Browse a nested configuration

Example 2

$config | Show-ConsoleObject -PassThru

Return a selected member value

Example 3

$config | Show-ConsoleObject -RootPath '$config' -PassThru Path

Return its PowerShell path

Parameters

-Depth Int32 optional: Maximum member depth below the root; default 8.
-Exclude String[] optional: Member names to skip without invoking their getters, supporting wildcards.
-Include String[] optional: Member names to include, supporting wildcards.
-InputObject PSObject requiredpipeline: True (ByValue): The object to browse, supplied directly or through the pipeline.
-MaxItems Int32 optional: Maximum items read from each collection; default 100.
-MaxNodes Int32 optional: Maximum visible members in an expansion; default 5000.
-Mode InteractionMode optional: Rich runs the keyboard explorer. Line, Accessible and None print the static inspector.; Possible values: Rich, Line, Accessible
-Output String optionalposition: 0: Value (default) or Path. The positional form supports -PassThru Path.; Possible values: Value, Path
-PassThru SwitchParameter optional: Returns the selected value after F10 or Ctrl+Enter. Add the positional word Path to return its expression instead.
-RootPath String optional: The variable expression at the start of returned paths; default $x. It is displayed, never evaluated.
-Title String optional: The screen title.
-Width Int32 optional: Width used by the static fallback; zero detects the host width.

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.