Descubra um comando usando o sistema de ajuda

  • 1 minuto

Usando o sistema de ajuda interno no PowerShell, você pode saber mais sobre um comando específico. Use o Get-Command cmdlet para localizar um comando necessário. Depois de localizar o comando, você pode querer saber mais sobre o que o comando faz e várias maneiras de chamá-lo.

Descubra cmdlets usando o sistema de ajuda e Get-Help

Você pode usar o Get-Help cmdlet principal para saber mais sobre um comando. Normalmente, você invoca Get-Help especificando-o por nome e adicionando o sinalizador que contém o nome do cmdlet sobre o -Name qual deseja aprender. Eis um exemplo:

Get-Help -Name Get-Help

Ajuda para atualizar

As novas versões do PowerShell não incluem o sistema de ajuda por padrão. Na primeira vez que executar Get-Helpo , ser-lhe-á pedido para instalar os ficheiros de ajuda. Você também pode executar o Update-Help cmdlet para instalar os arquivos de ajuda. Como uma chamada para Update-Help baixar muitos arquivos de ajuda, o comando pode buscar apenas uma vez por dia por padrão. Você pode substituir esse comportamento de busca usando o -Force sinalizador.

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

Aqui está um comando de exemplo:

Update-Help -UICulture en-US -Verbose

Este comando especifica o -UICulture sinalizador. Ele dá a ele o valor en-US, que busca arquivos de ajuda em inglês dos EUA. Para atualizar seus arquivos de ajuda no macOS ou Linux, use uma cultura que corresponda à cultura da sua máquina.

Explore as secções de ajuda

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

  • NAME: Fornece o nome do comando.
  • SINTAXE: Mostra maneiras de chamar o comando usando uma combinação de sinalizadores e, às vezes, parâmetros permitidos.
  • ALIASES: Lista todos os aliases de um comando. Um alias é um nome diferente para um comando e pode ser usado para invocar o comando.
  • OBSERVAÇÕES: Fornece informações sobre quais comandos executar para obter mais ajuda para esse comando.
  • PARAMETERS: Fornece detalhes sobre o parâmetro. Ele lista seu tipo, uma descrição mais longa e valores aceitáveis, se aplicável.

Filtrar a resposta da ajuda

Se você não quiser exibir a página de ajuda completa, restrinja a resposta adicionando sinalizadores ao comando Get-Help . Aqui estão algumas bandeiras 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 parâmetros.
  • Exemplos: Devolve apenas exemplos, se existirem.
  • Online: Abre uma página Web para o seu comando.
  • Parâmetro: Requer um nome de parâmetro como argumento. Ele lista as propriedades de um parâmetro específico.

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

Get-Help Get-FileHash -Examples

Melhorar a experiência de leitura

Executar Get-Help retorna toda a página de ajuda. A página pode não fornecer a melhor experiência de leitura. Talvez seja necessário rolar para encontrar a seção que deseja ler. Uma abordagem melhor é usar o help alias. O help alias se encaixa Get-Help em uma função que garante que sua saída seja legível linha por linha. Também torna a resposta legível página por página, paginando a saída. Você usará o help alias na próxima unidade.