Cmdlet

Get-IntelligenceXHealth

Namespace IntelligenceX.PowerShell

Inputs

IntelligenceX.OpenAI.IntelligenceXClient

Outputs

IntelligenceX.PowerShell.HealthReportRecord

Runs health checks for OpenAI app-server and optional Copilot CLI.

Examples

Example 1


Get-IntelligenceXHealth

Check OpenAI app-server health

Example 2


Get-IntelligenceXHealth -Copilot

Check OpenAI and Copilot CLI health

Example 3


Get-IntelligenceXHealth -Copilot -CopilotCliPath "copilot" -CopilotAutoInstall

Check Copilot with explicit path and auto-install enabled

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.

Syntax

Get-IntelligenceXHealth [-Client <IntelligenceXClient>] [-Copilot] [-CopilotAutoInstall] [-CopilotCliPath <string>] [-CopilotCliUrl <string>] [-CopilotInstallMethod <Auto|Winget|Homebrew|Npm|Script>] [-CopilotInstallPrerelease] [-CopilotWorkingDirectory <string>] [-NoConfig] [<CommonParameters>]

Parameters

Client IntelligenceXClient optionalposition: namedpipeline: true (ByValue): OpenAI/app-server client instance. Defaults to the active client.
Copilot SwitchParameter optionalposition: namedpipeline: false: Run a Copilot CLI health check.
CopilotAutoInstall SwitchParameter optionalposition: namedpipeline: false: Auto-install Copilot CLI if missing.
CopilotCliPath string optionalposition: namedpipeline: false: Copilot CLI path.
CopilotCliUrl string optionalposition: namedpipeline: false: Copilot CLI URL (host:port).
CopilotInstallMethod CopilotCliInstallMethod optionalposition: namedpipeline: falsevalues: 5: Copilot auto-install method to use when -CopilotAutoInstall is set. Possible values: Auto, Winget, Homebrew, Npm, Script; Possible values: Auto, Winget, Homebrew, Npm, Script
CopilotInstallPrerelease SwitchParameter optionalposition: namedpipeline: false: Copilot auto-install prerelease.
CopilotWorkingDirectory string optionalposition: namedpipeline: false: Copilot CLI working directory.
NoConfig SwitchParameter optionalposition: namedpipeline: false: Ignore .intelligencex/config.json overrides.

Outputs

IntelligenceX.PowerShell.HealthReportRecord