Korzystanie z polecenia Show-Command i Get-Help w programie PowerShell

  • 10 min

Polecenie cmdlet Show-Command otwiera okno z listą poleceń lub parametrami określonego polecenia.

Uwaga

Windows PowerShell ISE przywołany w tej lekcji jest dostępny tylko dla Windows PowerShell 5.1. Program ISE nie jest już w aktywnym tworzeniu funkcji i nie jest obsługiwany w programie PowerShell 7. Microsoft zaleca Visual Studio Code z rozszerzeniem programu PowerShell jako nowoczesne środowisko skryptowe zarówno dla programu Windows PowerShell, jak i programu PowerShell 7. Możesz użyć Show-Command w zintegrowanym terminalu programu VS Code.

W programie Windows PowerShell ISE to jest to samo okno, które jest wyświetlane po wybraniu opcji Pokaż Okno poleceń.

Aby wyświetlić parametry określonego polecenia, podaj nazwę polecenia jako wartość parametru -Name . Aby na przykład otworzyć Pokażokno polecenia przy użyciu polecenia użytego do pobrania użytkownika usługi Active Directory, wprowadź następujące polecenie w konsoli, a następnie naciśnij klawisz Enter.

Show-Command –Name Get-ADUser

Parametr -Name jest pozycyjny, więc następujące polecenie generuje ten sam wynik:

Show-Command Get-ADUser

Jeśli wybierzesz opcję Pokażokno polecenia w środowisku ISE, a kursor znajduje się w obrębie lub natychmiast obok nazwy polecenia w konsoli lub okienku skryptów, wyniki są takie same.

Uwaga

W tych przykładach polecenie Show-Command jest poleceniem, które jest rzeczywiście uruchomione, ale Get-ADUser jest nazwą polecenia, które chcesz przejrzeć w oknie dialogowym.

W oknie Pokażpolecenie każdy parametr ustawiony dla określonego polecenia jest wyświetlany na osobnej karcie. Ten układ karty sprawia, że wizualnie nie można mieszać i dopasowywać parametrów między zestawami.

Po podaniu wartości dla wszystkich wymaganych parametrów możesz uruchomić polecenie natychmiast, wybierając polecenie Uruchom w oknie Pokaż polecenia. Możesz również skopiować go do Schowka, wybierając pozycję Kopiuj. Z Schowka możesz wkleić polecenie do konsoli, aby przejrzeć poprawną składnię wiersza polecenia bez jego uruchamiania.

Zwróć uwagę, że polecenie Show-Command uwidacznia również program PowerShell common parameters, który jest zestawem parametrów dodanych do wszystkich poleceń w celu zapewnienia wstępnie zdefiniowanego zestawu podstawowych możliwości. Więcej informacji na temat wielu typowych parametrów znajdziesz w kolejnych modułach. Jeśli jednak chcesz dowiedzieć się o nich teraz, uruchom pomoc about_common_parameters w programie PowerShell i przejrzyj wyniki.

Korzystanie z polecenia Get-Help

Program PowerShell zapewnia obszerną pomoc dotyczącą poleceń w produkcie. Dostęp do tej pomocy można uzyskać za pomocą polecenia Get-Help . Polecenie Get-Help wyświetla całą zawartość pomocy na ekranie i umożliwia jej przewinięcie. Możesz również użyć funkcji Pomoc lub aliasu Man, który odpowiada poleceniu Get-Help. Wszystkie trzy zwracają zasadniczo te same wyniki. Wyniki te obejmują krótki i długi opis polecenia cmdlet, składnię, wszelkie dodatkowe uwagi od autora pomocy oraz linki do powiązanych poleceń cmdlet lub dodatkowych informacji online. Polecenia help i man wyświetlają zawartość w konsoli po jednej stronie. Środowisko ISE wyświetla całą zawartość pomocy.

Aby na przykład wyświetlić informacje pomocy dla cmdlet Get-ChildItem, wprowadź następujące polecenie w konsoli, a następnie naciśnij Enter.

Get-Help Get-ChildItem

Parametry Get-Help

Polecenie Get-Help akceptuje parametry, które umożliwiają znajdowanie dodatkowych informacji poza wyświetlanymi domyślnie informacjami. Typowym powodem, dla którego należy szukać dodatkowej pomocy, jest zidentyfikowanie przykładów użycia dla polecenia. Polecenia programu PowerShell często zawierają wiele takich przykładów. Na przykład uruchomienie polecenia Get-Help Stop-Process –Examples zawiera przykłady użycia cmdlet Stop-Process.

Parametr -Full zawiera szczegółowe informacje o cmdlet, w tym:

  • Opis każdego parametru.
  • Czy każdy parametr ma wartość domyślną (chociaż te informacje nie są spójnie udokumentowane we wszystkich poleceniach).
  • Określa, czy parametr jest obowiązkowy.
  • Czy parametr może przyjmować wartość na określonej pozycji (w takim przypadku podany jest numer pozycji, zaczynając od 1) lub czy trzeba podać nazwę parametru (w takim przypadku wyświetla się nazwane).
  • Czy parametr akceptuje dane wejściowe potoku i, jeśli tak, w jaki sposób.

Inne parametry Get-Help obejmują:

  • -ShowWindow. Wyświetla temat pomocy w osobnym oknie, co znacznie ułatwia dostęp do pomocy podczas wprowadzania poleceń.
  • -Online. Wyświetla wersję online tematu pomocy (zazwyczaj najbardziej aktualne informacje) w oknie przeglądarki.
  • -Parameter ParameterName. Wyświetla opis nazwanego parametru.
  • -Category. Wyświetla pomoc tylko dla niektórych kategorii poleceń, takich jak polecenia cmdlet i funkcje.

Znajdowanie poleceń za pomocą polecenia Get-Help

Polecenie Get-Help jest przydatne do znajdowania poleceń. Akceptuje symbole wieloznaczne (*, ?), w szczególności symbol gwiazdki (*). Gdy poprosisz o pomoc i użyjesz symboli wieloznacznych z częściową nazwą polecenia, program PowerShell wyświetli listę pasujących tematów pomocy.

Korzystając z informacji poznanych wcześniej na temat struktury cmdletów czasownik-rzeczownik, możesz użyć Get-Help jako narzędzia do odnajdywania cmdletów, nawet jeśli nie znasz ich nazw. Jeśli na przykład chcesz uzyskać wszystkie polecenia cmdlet działające na procesach, możesz wprowadzić polecenie Get-Help *process* w konsoli, a następnie nacisnąć Enter. Wyniki są zgodne z tymi zwróconymi przez polecenie Get-Command *process*, z tą różnicą, że polecenie Get-Help wyświetla streszczenie. Ten opis jest krótkim opisem, który ułatwia zidentyfikowanie żądanego polecenia.

Czasami można zdefiniować wyszukiwanie wieloznaczne, które nie jest zgodne z żadną nazwą polecenia. Na przykład uruchomienie polecenia Get-Help *beep* nie spowoduje znalezienia żadnych poleceń, które mają sygnał dźwiękowy w nazwie. Gdy nie zostaną znalezione żadne wyniki, system pomocy wykonuje wyszukiwanie pełnotekstowe dostępnych opisów poleceń i synopses. To wyszukiwanie lokalizuje wszystkie pliki pomocy zawierające sygnał dźwiękowy. Jeśli istnieje tylko jeden plik z dopasowaniem, system pomocy wyświetla jego zawartość, zamiast wyświetlać jednoelementową listę. W przypadku terminu wyszukiwania beep, funkcja Get-Help zwraca listę dwóch tematów: Set-PSReadlineOption, polecenie cmdlet i about_Special_Characters, temat pomocy koncepcyjnej.