en-US/PSIntro-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ModuleStatus</command:name> <command:verb>Get</command:verb> <command:noun>ModuleStatus</command:noun> <maml:description> <maml:para>Get key module status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this command to check the status of key modules. The command will return a list of modules with their online version, installed version, and whether an update is needed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ModuleStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The module names to check. The PSReadline and Microsoft.PowerShell.PSResourceGet modules are included by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSReadline, Microsoft.PowerShell.PSResourceGet</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The module names to check. The PSReadline and Microsoft.PowerShell.PSResourceGet modules are included by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSReadline, Microsoft.PowerShell.PSResourceGet</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ModuleStatusInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ModuleStatus Name Online Installed UpdateNeeded ---- ------ --------- ------------ PSReadLine 2.4.5 2.4.5 False Microsoft.PowerShell.PSResourceGet 1.1.1 1.1.1 False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ModuleStatus -Module Pester,PSReadline,PackageManagement Name Online Installed UpdateNeeded ---- ------ --------- ------------ Pester 5.7.1 5.7.1 False PSReadLine 2.4.5 2.4.5 False PackageManagement 1.4.8.1 1.4.8.1 False</dev:code> <dev:remarks> <maml:para>Check the status of user-specified modules.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-Content C:\scripts\MyModules.txt | Get-ModuleStatus Name Online Installed UpdateNeeded ---- ------ --------- ------------ Microsoft.PowerShell.ConsoleGuiTools 0.7.7 0.7.7 False Microsoft.PowerShell.Crescendo 1.1.0 1.1.0 False Microsoft.PowerShell.PlatyPS 1.0.1 1.0.0 True Microsoft.PowerShell.PSResourceGet 1.1.1 1.1.1 False Microsoft.WinGet.Client 1.11.460 1.12.350 False Microsoft.PowerShell.WhatsNew 0.5.5 0.5.5 False Microsoft.PowerShell.ThreadJob 2.2.0 2.2.0 False</dev:code> <dev:remarks> <maml:para>Check module status from a list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/a14c2e</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSIntro</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ProfileStatus</command:name> <command:verb>Get</command:verb> <command:noun>ProfileStatus</command:noun> <maml:description> <maml:para>Get the status of PowerShell profile scripts for the current host.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Run this command to get the status of PowerShell profile scripts for the current host. The output includes the profile name, path, and whether the profile script exists. The PowerShell profile script paths are hard-coded based on the current host and user context. The script files do not exist by default. You must create them if you want to customize your PowerShell environment. Note that you may also have to create additional folders.</maml:para> <maml:para>The built-in $profile variable defaults to the profile script for the current user in the current PowerShell host. Read the help topic about_Profiles to learn more.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ProfileStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProfileStatusInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-ProfileStatus Computername: CADENZA [ConsoleHost] ProfileName Path Exists ----------- ---- ------ AllUsersAllHosts C:\Program Files\PowerShell\7\profile.ps1 True AllUsersCurrentHost C:\Program Files\PowerShell\7\Microsoft.PowerShell_profile.ps1 False CurrentUserAllHosts C:\Users\jeff\Documents\PowerShell\profile.ps1 True CurrentUserCurrentHost C:\Users\jeff\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 True</dev:code> <dev:remarks> <maml:para>Profiles that do not exist will be highlighted in red.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/ef37d8</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>About_Profiles</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_profiles</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSIntro</command:name> <command:verb>Get</command:verb> <command:noun>PSIntro</command:noun> <maml:description> <maml:para>Display a PowerShell welcome screen</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will display a PowerShell welcome or "splash" screen. The display includes a list of online resources. If you include the -ModuleStatus parameter, the output will include the status of key modules. Keeping these modules up to date will help ensure a good user experience.</maml:para> <maml:para>If you include -Tutorial, you will be prompted to run a set of tutorials. The tutorials are interactive and will help the user learn about PowerShell. If the user chooses to run the tutorials, they will be run consecutively. The tutorials are written as PowerShell scripts with a combination of formatted text and live console output from the user's current PowerShell session. This ensures that output is relevant to the user's environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSIntro</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleStatus</maml:name> <maml:description> <maml:para>Include key module status.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tutorial</maml:name> <maml:description> <maml:para>Show the tutorial prompt. If you select Yes, the tutorials will run consecutively, in order. If you select No, the command will exit without running any tutorials. You can run Start-PSTutorial to launch the tutorials at any time and in any order.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModuleStatus</maml:name> <maml:description> <maml:para>Include key module status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tutorial</maml:name> <maml:description> <maml:para>Show the tutorial prompt. If you select Yes, the tutorials will run consecutively, in order. If you select No, the command will exit without running any tutorials. You can run Start-PSTutorial to launch the tutorials at any time and in any order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has aliases of PSIntro and PSWelcome.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-PSIntro -ModuleStatus Welcome to PowerShell! PowerShell v7.5.4 PowerShell Documentation : https://learn.microsoft.com/powershell PowerShell on Slack : https//aka.ms/psslack PowerShell on Discord : https://aka.ms/psdiscord PowerShell Team Blog : https://devblogs.microsoft.com/powershell PowerShell Gallery : https://www.powershellgallery.com GitHub Discussion : https://github.com/PowerShell/PowerShell/discussions Use any of the links above to get started learning more about PowerShell. When you can, you should run Update-Help to get the latest help files for PowerShell. Key module status: Name Online Installed UpdateNeeded ---- ------ --------- ------------ PSReadLine 2.4.5 2.4.5 False Microsoft.PowerShell.PSResourceGet 1.1.1 1.1.1 False All key modules are up to date. Run Start-PSTutorial for a list of brief PowerShell tutorials.</dev:code> <dev:remarks> <maml:para>The output will for formatted and styled using $PSStyle. The links will be clickable in Windows Terminal or similar.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-PSIntro -Tutorial Welcome to PowerShell! PowerShell v7.5.4 PowerShell Documentation : https://learn.microsoft.com/powershell PowerShell on Slack : https//aka.ms/psslack PowerShell on Discord : https://aka.ms/psdiscord PowerShell Team Blog : https://devblogs.microsoft.com/powershell PowerShell Gallery : https://www.powershellgallery.com GitHub Discussion : https://github.com/PowerShell/PowerShell/discussions Use any of the links above to get started learning more about PowerShell. When you can, you should run Update-Help to get the latest help files for PowerShell. Would you like to run a set of short interactive tutorial on essential PowerShell fundamentals? Enter Y to continue:</dev:code> <dev:remarks> <maml:para>Launch the introduction with the tutorial prompt.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/4d142b</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-PSTutorial</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-PSTutorial</command:name> <command:verb>Start</command:verb> <command:noun>PSTutorial</command:noun> <maml:description> <maml:para>Start an interactive PowerShell tutorial</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command serves as a launcher for the tutorials included in the PSIntro module. You can select a tutorial topic. If you don't specify a topic, you will get a simple menu of interactive PowerShell tutorials. The tutorial consists of a combination of text and information from your host and PowerShell environment.</maml:para> <maml:para>The tutorial will be displayed in "pages" with prompts to continue. Press `Enter` to continue or 'q' to quit. Your progress will not be saved.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-PSTutorial</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Topic</maml:name> <maml:description> <maml:para>Specify a tutorial topic otherwise you will be presented with a menu of topics. Valid topics are:</maml:para> <maml:para>- PowerShell Essentials</maml:para> <maml:para>- Get-Command</maml:para> <maml:para>- Get-Help</maml:para> <maml:para>- Get-Member</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Topic</maml:name> <maml:description> <maml:para>Specify a tutorial topic otherwise you will be presented with a menu of topics. Valid topics are:</maml:para> <maml:para>- PowerShell Essentials</maml:para> <maml:para>- Get-Command</maml:para> <maml:para>- Get-Help</maml:para> <maml:para>- Get-Member</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-PSTutorial PowerShell Tutorial Menu 1 - PowerShell Essentials 2 - Get-Command 3 - Get-Help 4 - Get-Member 5 - Quit Select a menu option [1-5]:</dev:code> <dev:remarks> <maml:para>The menu title will be formatted using $PSStyle.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Start-PSTutorial -Topic 'Get-Command'</dev:code> <dev:remarks> <maml:para>Launch the Get-Command tutorial.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/63bfe0</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSIntro</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |