Não há cmdlets mais familiares para novatos e especialistas do que o Comando de Ajuda do PowerShell, Get-Help. Devido ao sistema de ajuda integrado e atualizável do PowerShell, o comando Get-Help do PowerShell é a maneira pela qual você descobre o que os comandos fazem, seus parâmetros e até (esperamos) muitos exemplos úteis de como usar o comando.
Cada cmdlet e função com os quais você se depara deve ter conteúdo de ajuda associado a ele que o cmdlet Get-Help do PowerShell pode ler. Digo “deve ter” porque, infelizmente, alguns autores não incluem conteúdo de ajuda.
O conteúdo de ajuda associado aos comandos pode ser encontrado executando Get-Help. Este comando lê tanto a ajuda baseada em comentários quanto a ajuda baseada em XML que é criada pelo autor do cmdlet ou função.
O uso mais comum do cmdlet Get-Help é usá-lo para encontrar conteúdo de ajuda para um comando específico. Por exemplo, talvez você tenha descoberto um novo comando chamado Get-Content com o cmdlet Get-Command e queira saber mais informações sobre ele. Você usaria o parâmetro Name no Get-Help. Isso retornaria um conjunto básico de informações sobre esse comando, como você pode ver abaixo.
Você notará que, embora muitas informações sejam retornadas, é apenas um resumo das coisas que você pode fazer. E você nunca saberia que Get-Help pode retornar outros tipos de conteúdo de ajuda, como exemplos.
Encontrando Informações de Parâmetros
Você pode aprofundar no conteúdo de ajuda de várias maneiras diferentes. Uma dessas maneiras é encontrar informações sobre um único parâmetro de um comando. Talvez, no exemplo que estou usando aqui, eu veja uma referência a um parâmetro Raw e não tenha certeza do que esse parâmetro faz. Posso usar o parâmetro Parameter no Get-Help com o parâmetro Name para retornar apenas informações sobre esse parâmetro específico do comando.
PowerShell Get-Help e Exemplos
Uma das melhores coisas sobre o sistema de ajuda do PowerShell é que ele tem suporte nativo para exemplos. Exemplos são uma excelente maneira de ver, com contexto, como usar um comando específico. Se o autor do comando adicionou exemplos ao conteúdo de ajuda, você pode ver esses exemplos usando o parâmetro Examples . Quando você usa esse parâmetro, o Get-Help retornará um ou mais exemplos de como esse comando é usado em diferentes circunstâncias.
Obtendo Ajuda Detalhada
Resumos, informações de parâmetros e exemplos não são as únicas informações retornadas pelo comando Get-Help do PowerShell. Às vezes, você precisa ver todas as informações disponíveis para um cmdlet. Nesse caso, você sempre tem os parâmetros Detailed e Full disponíveis. Cada um desses parâmetros exibe uma quantidade crescente de informações.
O parâmetro Detailed adiciona descrições e exemplos de parâmetros à exibição de ajuda principal. Em essência, eles combinam o uso do parâmetro Examples e exibirão informações para todos os parâmetros como se você tivesse usado o parâmetro Parameter em todos os parâmetros de comando.
Se o parâmetro Detailed não for suficiente; você sempre pode adotar uma abordagem nuclear e retornar todo o conteúdo de ajuda com o parâmetro Full. Este parâmetro não filtra informações de forma alguma. O parâmetro Full lê todo o conteúdo de ajuda definido para um comando específico.
Obtendo uma Abordagem Gráfica
Se você deseja uma representação mais gráfica da ajuda, também pode usar o parâmetro ShowWindow. Este parâmetro abre uma janela que permite pesquisar facilmente o conteúdo de ajuda e mostrar apenas determinadas áreas por meio do botão Settings. Esta visualização é útil se você realmente deseja investigar o conteúdo da ajuda.
Resumo
Há alguns outros parâmetros menos comuns que você pode usar com o comando PowerShell Get-Help. Se estiver interessado em aprender mais, você sabe como encontrar informações sobre esses parâmetros adicionais, certo? Sim, Get-Help pode encontrar conteúdo de ajuda sobre si mesmo.
Use o comando Get-Help religiosamente ao procurar mais informações sobre comandos do PowerShell. Não há muita necessidade de recorrer ao Google quando você tem um sistema de ajuda poderoso e um comando para ajudá-lo a acessá-lo.