Нет командлетов, более знакомых как новичкам, так и экспертам, чем команда справки PowerShell – Get-Help. Благодаря встроенной и обновляемой системе справки PowerShell, команда Get-Help – это способ узнать, что делают команды, их параметры, а также (надеюсь) множество полезных примеров использования команды.
Каждый командлет и функция, с которыми вы сталкиваетесь, должны содержать встроенный справочный материал, который может быть прочитан командой PowerShell Get-Help. Я говорю “должны”, потому что, к сожалению, некоторые авторы не включают справочный контент.
Справочный материал, связанный с командами, можно найти, запустив Get-Help. Эта команда читает как основанный на комментариях, так и основанный на XML-структуре справочный материал, созданный автором командлета или функции.
Наиболее распространенное использование команды Get-Help – использовать ее для поиска справочного материала для определенной команды. Например, предположим, вы обнаружили новую команду с именем Get-Content с помощью команды Get-Command и хотите узнать больше информации о ней. Вы бы использовали параметр Name на Get-Help. Это вернуло бы базовый набор информации о данной команде, как вы можете видеть ниже.
Вы заметите, что хотя возвращается много информации, это всего лишь краткое изложение того, что вы можете сделать. И вы никогда не узнаете, что Get-Help также может возвращать другие типы справочного контента, такие как примеры.
Поиск информации о параметрах
Вы можете углубиться в справочный контент несколькими разными способами. Один из них – найти информацию о конкретном параметре команды. Возможно, в приведенном здесь примере я вижу ссылку на параметр Raw и не совсем уверен, что этот параметр делает. Я могу использовать параметр Parameter на Get-Help с параметром Name, чтобы вернуть только информацию о этом конкретном параметре команды.
PowerShell Get-Help и примеры
Одна из лучших вещей в системе справки PowerShell заключается в том, что она имеет встроенную поддержку примеров. Примеры – отличный способ увидеть, с контекстом, как использовать конкретную команду. Если автор команды добавил примеры в свой справочный контент, вы можете увидеть эти примеры, используя параметр Examples. Когда вы используете этот параметр, Get-Help вернет один или несколько примеров того, как использовать эту команду в различных ситуациях.
Получение подробной справки
Краткое изложение, информация о параметрах и примеры – не единственная информация, возвращаемая командой Get-Help в PowerShell. Иногда вам нужно увидеть всю доступную информацию о команде. В таком случае у вас всегда есть параметры Detailed и Full. Каждый из этих параметров отображает все больше информации.
Параметр Detailed добавляет описания параметров и примеры к основному отображению справки. По сути, они объединяют использование параметра Examples и отображают информацию для всех параметров, как если бы вы использовали параметр Parameter для всех параметров команды.
Если параметра Detailed недостаточно, всегда можно воспользоваться радикальным подходом и вернуть всю справочную информацию с параметром Full. Этот параметр не фильтрует информацию вообще. Параметр Full читает всю справочную информацию, определенную для конкретной команды.
Получение Графического
Если вы хотите более графического представления справки, можно также использовать параметр ShowWindow. Этот параметр открывает окно, позволяющее легко искать справочную информацию и отображать только определенные области с помощью кнопки Настройки. Это представление полезно, если вы действительно хотите провести расследование справочной информации.
Резюме
Есть еще несколько менее распространенных параметров, которые можно использовать с командой PowerShell Get-Help. Если вы заинтересованы в изучении подробностей, вы знаете, как найти информацию о этих дополнительных параметрах, верно? Да, Get-Help может найти справочную информацию о самом себе.
Используйте команду Get-Help религиозно, когда ищете больше информации о командах PowerShell. Нет особой необходимости обращаться к Google, когда у вас есть мощная система справки и команда, помогающая вам в нее войти.