Não há cmdlets mais familiares para novatos e especialistas do que o comando de Ajuda do PowerShell, Get-Help. Devido ao sistema integrado e atualizável de ajuda do PowerShell, o comando Get-Help do PowerShell é a maneira de descobrir o que os comandos fazem, seus parâmetros e até (esperançosamente) 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 incorporado que o cmdlet Get-Help do PowerShell pode ler. Eu 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 é utilizá-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 obter 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 também, como exemplos.
Encontrando Informações de Parâmetros
Você pode aprofundar o 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 de comando específico.
PowerShell Get-Help e Exemplos
Uma das melhores coisas sobre o sistema de ajuda do PowerShell é que ele possui 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 deles, você pode ver esses exemplos usando o parâmetro Examples. Quando você usa este parâmetro, Get-Help retornará um ou mais exemplos de como esse comando é usado em diferentes circunstâncias.
Obtendo Ajuda Detalhada
Sumários, 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 a abordagem nuclear e retornar todo o conteúdo da ajuda com o parâmetro Full. Este parâmetro não filtra nenhuma informação. O parâmetro Full lê todo o conteúdo da ajuda definido para um comando específico.
Tornando-se Gráfico
Se você deseja uma representação mais gráfica da ajuda, também pode usar o parâmetro ShowWindow. Esse parâmetro abre uma janela que permite pesquisar facilmente o conteúdo da ajuda e mostrar apenas áreas específicas através do botão Configurações. Essa visualização é útil se você realmente deseja investigar o conteúdo da ajuda.
Resumo
Existem alguns outros parâmetros menos comuns que você pode usar com o comando Get-Help do PowerShell. Se você estiver interessado em aprender mais, sabe como encontrar informações sobre esses parâmetros adicionais, certo? Sim, o Get-Help pode encontrar o conteúdo da ajuda sobre si mesmo.
Use o comando Get-Help religiosamente ao procurar mais informações sobre comandos do PowerShell. Não há necessidade de recorrer ao Google quando você tem um sistema de ajuda poderoso e um comando para ajudá-lo a aproveitá-lo.