Descobrir um comando ao usar o sistema de ajuda

Concluído 100 XP

Ao usar o sistema de ajuda integrado no PowerShell, você pode saber mais sobre um comando específico. Use o cmdlet Get-Command para localizar um comando necessário. Depois de ter localizado o comando, você talvez queira saber mais sobre o que ele faz e as diversas maneiras de chamá-lo.

Descobrir cmdlets usando o sistema de ajuda e Get-Help

Use o cmdlet básico Get-Help para saber mais sobre um comando. Normalmente, você invoca Get-Help especificando-o pelo nome e adicionando o sinalizador -Name que contém o nome do cmdlet sobre o qual você deseja saber. Veja um exemplo:

PowerShell
Get-Help -Name Get-Help

Atualizar ajuda

As novas versões do PowerShell não incluem o sistema de ajuda por padrão. Na primeira vez que você executar Get-Help, precisará instalar os arquivos de ajuda. Execute também o cmdlet Update-Help para instalar os arquivos de ajuda. Como uma chamada a Update-Help baixa muitos arquivos de ajuda, o comando pode fazer a busca apenas uma vez por dia, por padrão. Substitua esse comportamento de busca usando o sinalizador -Force.

Os arquivos de ajuda são atualizados de modo diferente no Windows em comparação com o Linux ou o macOS. O processo é diferente, porque quando você executa o cmdlet Update-Help, os arquivos de ajuda são buscados pela Internet, pela correspondência com a cultura do seu computador. No Windows, uma cultura já está instalada, mas está ausente no Linux e no macOS. Portanto, você precisa especificar uma cultura ao atualizar os arquivos de ajuda no Linux e no macOS.

Veja um comando de exemplo:

PowerShell
Update-Help -UICulture en-US -Verbose

Esse comando especifica o sinalizador -UICulture. Ele fornece o valor en-US, que busca arquivos de ajuda em Inglês dos EUA. Para atualizar os arquivos de ajuda no macOS ou no Linux, use uma cultura que corresponda à cultura do seu computador.

Explorar as seções de ajuda

Quando você invoca Get-Help em um cmdlet, uma página de ajuda é retornada. A página inclui muitas seções. Provavelmente, você verá estas seções comuns:

  • NAME: fornece o nome do comando.
  • SYNTAX: mostra as maneiras de chamar o comando por meio de uma combinação de sinalizadores e, às vezes, parâmetros permitidos.
  • ALIASES: lista todos os aliases para um comando. Um alias é um nome diferente para um comando e pode ser usado para invocá-lo.
  • REMARKS: fornece informações sobre quais comandos executar para obter mais ajuda para esse comando.
  • PARAMETERS: fornece detalhes sobre o parâmetro. Ele lista o tipo, uma descrição mais longa e os valores aceitáveis, se aplicável.

Filtrar a resposta da ajuda

Caso não deseje ver a página de ajuda completa, restrinja a resposta adicionando sinalizadores ao comando Get-Help. Veja alguns sinalizadores que você pode usar:

  • Completo: retorna uma página de ajuda detalhada. Ele especifica informações como parâmetros, entradas e saídas que você não obtém na resposta padrão.
  • Detalhado: retorna uma resposta que se parece com a resposta padrão, mas inclui uma seção para os parâmetros.
  • Exemplos: retorna apenas exemplos, se existirem.
  • Online: abre uma página da Web para o seu comando.
  • Parâmetro: requer um nome de parâmetro como um argumento. Ele lista as propriedades de um parâmetro específico.

Por exemplo, você pode usar o comando a seguir para retornar apenas a seção Exemplos da página de ajuda.

PowerShell
Get-Help Get-FileHash -Examples

Aprimorar a experiência de leitura

A execução de Get-Help retorna toda a página de ajuda. Essa página pode não fornecer a melhor experiência de leitura. Talvez seja preciso rolar para encontrar a seção que você deseja ler. Uma abordagem melhor é usar o alias help. O alias help redireciona Get-Help em uma função que garante que a saída seja legível linha por linha. Ele também pagina a saída, tornando a resposta legível página por página. Você usará o alias help na próxima unidade.


Unidade seguinte: Exercício – Usar a ajuda

Anterior Avançar