O PowerShell possui um sistema de ajuda integrado e poderoso, essencial para que você consiga aprender e utilizar novos cmdlets sem precisar consultar a internet constantemente. Nesta aula, você aprenderá a usar os principais comandos relacionados à ajuda: Get-Help, Update-Help e Get-Command, além de explorar exemplos práticos que facilitam o entendimento. Dominar essas ferramentas aumentará significativamente sua produtividade no dia a dia.

Entender como navegar pela ajuda local é fundamental, pois muitos ambientes corporativos podem ter restrições de acesso à internet. Por isso, manter a documentação atualizada e saber como consultá-la rapidamente é uma habilidade indispensável.

Get-Help

O cmdlet Get-Help é o principal ponto de entrada para obter informações sobre qualquer comando no PowerShell. Ele exibe a sintaxe, descrição, parâmetros, exemplos e notas detalhadas. Você pode usá-lo de várias formas: passando o nome de um cmdlet, função, script ou até mesmo um tópico conceitual (como about_*).

Por exemplo, para ver a ajuda completa do cmdlet Get-Process, basta digitar:

Get-Help Get-Process

Por padrão, o Get-Help exibe uma versão resumida. Para ver a ajuda completa, use o parâmetro -Full:

Get-Help Get-Process -Full

Você também pode usar -Detailed para obter um nível intermediário de detalhes. Além disso, o Get-Help aceita curingas, permitindo pesquisar comandos que contenham um termo específico, como:

Get-Help *process*

Isso lista todos os tópicos de ajuda que incluem "process" no nome.

Update-Help

O PowerShell permite baixar e atualizar a ajuda local para a versão mais recente disponível na internet. O cmdlet Update-Help faz esse trabalho. Sem a ajuda atualizada, você pode perder informações importantes, como novos parâmetros ou exemplos corrigidos.

Para atualizar a ajuda de todos os módulos instalados, execute:

Update-Help

Se você quiser atualizar apenas um módulo específico, use o parâmetro -Module:

Update-Help -Module Microsoft.PowerShell.Utility

Em ambientes sem acesso à internet, é possível usar o parâmetro -SourcePath para apontar para um diretório local contendo os arquivos de ajuda. Lembre-se de que, em algumas versões do Windows, pode ser necessário executar o PowerShell como administrador para atualizar a ajuda.

Exemplos (-Examples)

O parâmetro -Examples do Get-Help exibe apenas os exemplos práticos de uso do comando. Essa é uma forma rápida de aprender como utilizar um cmdlet sem ler toda a documentação.

Por exemplo, para ver os exemplos do cmdlet Select-Object, use:

Get-Help Select-Object -Examples

A saída mostrará uma lista numerada de exemplos, cada um com descrição e código. Você pode copiar e adaptar esses exemplos para suas próprias tarefas. Essa abordagem é muito útil quando você já conhece o cmdlet mas precisa de um lembrete rápido de sintaxe.

Além disso, você pode combinar -Examples com outros parâmetros, como -ShowWindow, que abre a ajuda em uma janela separada e pesquisável:

Get-Help Select-Object -Examples -ShowWindow

Get-Command

O cmdlet Get-Command é usado para descobrir comandos disponíveis no PowerShell. Ele lista cmdlets, funções, aliases, scripts e aplicativos. É uma ferramenta de descoberta que ajuda a encontrar o comando certo para a tarefa desejada.

Para listar todos os comandos que contêm a palavra "service", use:

Get-Command -Name *service*

Você pode filtrar por tipo de comando com o parâmetro -CommandType. Por exemplo, para listar apenas cmdlets:

Get-Command -CommandType Cmdlet

Ou para listar apenas aliases:

Get-Command -CommandType Alias

O Get-Command também pode ser usado para obter a sintaxe de um comando específico, semelhante ao Get-Help, mas de forma mais compacta:

Get-Command Get-Process -Syntax

Isso exibe a assinatura do comando, útil para ver rapidamente os parâmetros obrigatórios e opcionais.

Boas práticas

Sempre mantenha a ajuda atualizada executando Update-Help periodicamente. Utilize Get-Command para descobrir comandos novos e Get-Help -Examples para aprender rapidamente. Lembre-se de que a ajuda local é uma fonte confiável e offline de conhecimento.

Referências

Exercícios

  1. Use Get-Help para exibir a ajuda completa do cmdlet Get-Service. Qual é a descrição do parâmetro -Name?

✓ Resposta: Execute Get-Help Get-Service -Full e procure a descrição do parâmetro -Name. A descrição é: "Specifies the service names of services to be retrieved. Wildcards are permitted."
  • Atualize a ajuda do módulo Microsoft.PowerShell.Management. Qual comando você usou?

    • ✓ Resposta: Update-Help -Module Microsoft.PowerShell.Management
  • Utilize Get-Help -Examples para o cmdlet Where-Object. Quantos exemplos são exibidos?

    • ✓ Resposta: Execute Get-Help Where-Object -Examples. Normalmente são exibidos 5 exemplos (dependendo da versão).
  • Liste todos os cmdlets que contenham a palavra "item" usando Get-Command. Quantos cmdlets são retornados?

    • ✓ Resposta: Execute Get-Command -Name *item* -CommandType Cmdlet. O número varia, mas tipicamente entre 10 e 15.
  • Use Get-Command -Syntax para o cmdlet New-Item. Qual é o primeiro parâmetro listado?

    • ✓ Resposta: Execute Get-Command New-Item -Syntax. O primeiro parâmetro é [-Path] .