Как получить справку по командам PowerShell

PowerShell очень хорошо документирован. Каждый командлет имеет подробную справку с синтаксиса использования, указанием всех опций, примера команд.

В этой статье мы рассмотрим, как посмотреть справку по командам PowerShell, а также как узнать имена всех команд PowerShell.

Как узнать список всех команд PowerShell

Прежде чем узнать справку о команде, в первую очередь, нужно знать имя этой команды.

Чтобы узнать имена всех команд, запустите:

Get-Command

Будет выведена таблица с четырьмя столбцами:

• CommandType — тип команды (Alias, Function, Cmdlet)
• Name — имя команды
• Version — версия PowerShell с которой стала доступна данная команда
• Source — модуль, в котором присутствует эта команда

Чтобы вывести список всех команд отсортированных по модулям, выполните следующее:

Get-Command | Sort-Object -Property Source

Ещё одно представление, которое может быть полезным

Get-Command | Sort-Object -Property Noun | Format-Table -GroupBy Noun

Чтобы показать команды только определённого модуля, например, модуля Storage, используйте:

Get-Command -Module Storage

А эта команда покажет все командлеты модуля NetTCPIP:

Get-Command -module NetTCPIP

Как найти команду по части имени

Есть возможность фильтровать информацию, выводимую командой Get-Command. Допустим вы хотим посмотреть команды PowerShell содержащие слово «Alias», для этого нужно выполнить следующую команду:

Get-Command -Name *Alias

Как вывести список всех модулей в PowerShell

Чтобы узнать имена всех доступных модулей PowerShell выполните:

Get-Module -ListAvailable

Как узнать, в каком модуле находится командлет PowerShell

Чтобы узнать, к какому модулю относится команда, используйте конструкцию вида:

(Get-Command КОМАНДЛЕТ).ModuleName

Например, чтобы узнать, из какого модуля происходит команда Get-Date выполните:

(Get-Command Get-Date).ModuleName

Как получить справку о команде PowerShell

Чтобы получить справку по командлету выполните команду:

Get-Help КОМАНДЛЕТ

Например:

Get-Help Get-Module

Чтобы посмотреть примеры использования команды:

Get-Help КОМАНДЛЕТ -Examples

Следующая конструкция также выводит примеры использования КОМАНДЛЕТА, но вывод чуть отличается (в выводе, отсутствует название и синопсис):

(Get-Help КОМАНДЛЕТ).examples

Для вывода дополнительной информации используйте:

Get-Help КОМАНДЛЕТ -Detailed

Чтобы получить техническую информацию (полную справку), используйте команду вида:

Get-Help КОМАНДЛЕТ -Full

Справка PowerShell описывает командлеты, функции, сценарии и модули PowerShell и объясняет концепции, включая элементы языка PowerShell.

PowerShell не включает файлы справки, но вы можете прочитать разделы справки в Интернете или использовать командлет Update-Help для загрузки файлов справки на свой компьютер, а затем использовать командлет Get-Help для отображения разделов справки в командной строке.

Вы также можете использовать командлет Update-Help для загрузки обновлённых файлов справки по мере их выпуска, чтобы ваш локальный справочный контент никогда не устарел.

Без файлов справки Get-Help отображает автоматически созданную справку для командлетов, функций и сценариев.

Онлайн помощь

Вы можете найти справку по PowerShell в Интернете по адресу https://go.microsoft.com/fwlink/?LinkID=108518.

Чтобы открыть онлайн справку для любого командлета или функции, введите:

Get-Help КОМАНДЛЕТ -Online

В результате будет открыт веб-браузер со страницей документации по интересующей вас команде.

Обновление справки

Чтобы загрузить и установить файлы справки на свой компьютер:

1. Запустите PowerShell с параметром «Запуск от имени администратора».

2. Выполните команду:

Update-Help

Связанная статья: Как запустить PowerShell с правами администратора

После установки файлов справки вы можете использовать командлет Get-Help для отображения разделов справки. Вы также можете использовать командлет Update-Help для загрузки обновлённых файлов справки, чтобы ваши локальные файлы справки всегда были актуальными.

Для получения дополнительных сведений о командлете Update-Help введите:

Get-Help Update-Help -Online

или перейдите по ссылке: https://go.microsoft.com/fwlink/?LinkID=210614

Справка по концепциям языка PowerShell

Названия концептуальных тем начинаются с «About_». Чтобы получить помощь по концепции или языку, введите:

Get-Help About_ИМЯ-ТЕМЫ

Например:

Get-Help About_if

Чтобы вывести список концептуальных тем выполните команду:

Get-Help About_*