Compartilhar via

Integração do shell

  • Artigo

A partir da versão prévia do Terminal 1.15, o Terminal do Windows começou a dar suporte experimental a alguns recursos de "integração do shell". Esses recursos facilitam o uso da linha de comando. Em versões anteriores, habilitamos o shell para informar ao Terminal qual é o diretório de trabalho atual. Agora, adicionamos suporte para mais sequências para permitir que o shell descreva semanticamente partes da saída do terminal como um "prompt", um "comando" ou "saída". O shell também pode informar ao terminal se um comando foi bem-sucedido ou falhou.

Este é um guia para alguns dos recursos de integração do shell que implantamos a partir do Terminal v1.18. Estamos planejando criar ainda mais recursos no futuro, então adoraríamos receber alguns comentários adicionais sobre como as pessoas usam esses recursos.

Observação: a partir do Terminal 1.21, as marcas agora são um recurso estável. Antes da 1.21, as marcas só eram habilitadas para builds de Versão prévia do Terminal. Se você estiver usando uma versão do Terminal anterior à 1.21, a configuração showMarksOnScrollbar foi nomeada experimental.showMarksOnScrollbar e autoMarkPrompts foi nomeada experimental.autoMarkPrompts.

Como isso funciona?

A integração do shell funciona fazendo com que o shell (ou qualquer aplicativo de linha de comando) escreva "sequências de escape" especiais no Terminal. Essas sequências de escape não são impressas no Terminal. Em vez disso, elas fornecem bits de metadados que o terminal pode usar para saber mais sobre o que está acontecendo no aplicativo. Ao colocar essas sequências no prompt do shell, você pode fazer com que o shell forneça continuamente informações ao terminal que somente o shell conhece.

Para as seguintes sequências:

  • OSC é a cadeia de caracteres "\x1b]" – um caractere de escape, seguido por ]
  • ST é o "terminador de cadeia de caracteres" e pode ser \x1b\ (um caractere ESC, seguido por \) ou \x7 (o caractere BEL)
  • Espaços são meramente ilustrativos.
  • Cadeias de caracteres em <> são parâmetros que devem ser substituídos por algum outro valor.

As sequências de integração de shell com suporte relevantes a partir do Terminal v1.18 são:

  • OSC 133 ; A ST ("FTCS_PROMPT") – o início de um prompt.
  • OSC 133 ; B ST ("FTCS_COMMAND_START") – o início de uma linha de comando (LEIA: o final do prompt).
  • OSC 133 ; C ST ("FTCS_COMMAND_EXECUTED") – o início da saída do comando/o final da linha de comando.
  • OSC 133 ; D ; <ExitCode> ST ("FTCS_COMMAND_FINISHED") – o fim de um comando. ExitCode Se ExitCode for fornecido, o Terminal tratará 0 como "êxito" e qualquer outra coisa como um erro. Se omitido, o terminal deixará apenas a marca da cor padrão.

Como habilitar marcas de integração do shell

O suporte a esses recursos requer cooperação entre o shell e o Terminal. Você precisará habilitar as configurações no Terminal para usar esses novos recursos, bem como modificar o prompt do shell.

Para habilitar esses recursos no Terminal, você precisará adicionar o seguinte às suas configurações:

"profiles":
{
    "defaults":
    {
        // Enable marks on the scrollbar
        "showMarksOnScrollbar": true,

        // Needed for both pwsh, CMD and bash shell integration
        "autoMarkPrompts": true,

        // Add support for a right-click context menu
        // You can also just bind the `showContextMenu` action
        "experimental.rightClickContextMenu": true,
    },
}
"actions":
[
    // Scroll between prompts
    { "keys": "ctrl+up",   "command": { "action": "scrollToMark", "direction": "previous" }, },
    { "keys": "ctrl+down", "command": { "action": "scrollToMark", "direction": "next" }, },

    // Add the ability to select a whole command (or its output)
    { "command": { "action": "selectOutput", "direction": "prev" }, },
    { "command": { "action": "selectOutput", "direction": "next" }, },

    { "command": { "action": "selectCommand", "direction": "prev" }, },
    { "command": { "action": "selectCommand", "direction": "next" }, },
]

A forma como você habilita essas marcas no shell varia de shell para shell. Abaixo estão os tutoriais para CMD, PowerShell e Zsh.

PowerShell (pwsh.exe)

Se você nunca alterou o prompt do PowerShell antes, confira primeiro about_Prompts.

Precisaremos editá-lo prompt para garantir que comuniquemos o Terminal sobre o CWD e marquemos o prompt com as marcas apropriadas. O PowerShell também nos permite incluir o código de erro do comando anterior na sequência, o 133;D que permitirá que o terminal colora automaticamente a marca com base se o comando tiver sido gerado ou falhou.

Adicione o seguinte ao seu perfil do PowerShell:

$Global:__LastHistoryId = -1

function Global:__Terminal-Get-LastExitCode {
  if ($? -eq $True) {
    return 0
  }
  $LastHistoryEntry = $(Get-History -Count 1)
  $IsPowerShellError = $Error[0].InvocationInfo.HistoryId -eq $LastHistoryEntry.Id
  if ($IsPowerShellError) {
    return -1
  }
  return $LastExitCode
}

function prompt {

  # First, emit a mark for the _end_ of the previous command.

  $gle = $(__Terminal-Get-LastExitCode);
  $LastHistoryEntry = $(Get-History -Count 1)
  # Skip finishing the command if the first command has not yet started
  if ($Global:__LastHistoryId -ne -1) {
    if ($LastHistoryEntry.Id -eq $Global:__LastHistoryId) {
      # Don't provide a command line or exit code if there was no history entry (eg. ctrl+c, enter on no command)
      $out += "`e]133;D`a"
    } else {
      $out += "`e]133;D;$gle`a"
    }
  }


  $loc = $($executionContext.SessionState.Path.CurrentLocation);

  # Prompt started
  $out += "`e]133;A$([char]07)";

  # CWD
  $out += "`e]9;9;`"$loc`"$([char]07)";

  # (your prompt here)
  $out += "PWSH $loc$('>' * ($nestedPromptLevel + 1)) ";

  # Prompt ended, Command started
  $out += "`e]133;B$([char]07)";

  $Global:__LastHistoryId = $LastHistoryEntry.Id

  return $out
}

Configuração do Oh My Posh

Usando oh-my-posh? Você vai querer modificar um pouco o acima, para esconder o prompt original e, em seguida, adicioná-lo de volta no meio das sequências de escape de integração do shell.

# initialize oh-my-posh at the top of your profile.ps1
oh-my-posh init pwsh --config "$env:POSH_THEMES_PATH\gruvbox.omp.json" | Invoke-Expression
# then stash away the prompt() that oh-my-posh sets
$Global:__OriginalPrompt = $function:Prompt

function Global:__Terminal-Get-LastExitCode {
  if ($? -eq $True) { return 0 }
  $LastHistoryEntry = $(Get-History -Count 1)
  $IsPowerShellError = $Error[0].InvocationInfo.HistoryId -eq $LastHistoryEntry.Id
  if ($IsPowerShellError) { return -1 }
  return $LastExitCode
}

function prompt {
  $gle = $(__Terminal-Get-LastExitCode);
  $LastHistoryEntry = $(Get-History -Count 1)
  if ($Global:__LastHistoryId -ne -1) {
    if ($LastHistoryEntry.Id -eq $Global:__LastHistoryId) {
      $out += "`e]133;D`a"
    } else {
      $out += "`e]133;D;$gle`a"
    }
  }
  $loc = $($executionContext.SessionState.Path.CurrentLocation);
  $out += "`e]133;A$([char]07)";
  $out += "`e]9;9;`"$loc`"$([char]07)";
  
  $out += $Global:__OriginalPrompt.Invoke(); # <-- This line adds the original prompt back

  $out += "`e]133;B$([char]07)";
  $Global:__LastHistoryId = $LastHistoryEntry.Id
  return $out
}

Prompt de Comando de Administrador

Fontes do Prompt de Comando são prompt da PROMPT variável de ambiente. CMD.exe lê $e como um caractere ESC. Infelizmente, CMD.exe não tem uma maneira de obter o código de retorno do comando anterior no prompt, portanto, não podemos fornecer informações de êxito/erro em prompts cmd.

Você pode alterar o prompt para a instância CMD.exe atual executando:

PROMPT $e]133;D$e\$e]133;A$e\$e]9;9;$P$e\$P$G$e]133;B$e\

Ou você pode definir a variável da linha de comando para todas as sessões futuras:

setx PROMPT $e]133;D$e\$e]133;A$e\$e]9;9;$P$e\$P$G$e]133;B$e\

Esses exemplos pressupõem que o atual PROMPT seja apenas $P$G. Em vez disso, você pode optar por encapsular seu prompt atual com algo como:

PROMPT $e]133;D$e\$e]133;A$e\$e]9;9;$P$e\%PROMPT%$e]133;B$e\

Bash

Você pode adicionar o seguinte ao final do seu ~/.bashrc para habilitar a integração do shell no Bash:

PS1="\[\033]133;D;\007\]\[\033]133;A;\007\]$PS1\[\033]133;B;\007\]"

Isso encapsulará o $PS1 existente com as sequências necessárias para habilitar a integração do shell.

Nota: não encontrou seu shell favorito aqui? Se você descobrir, sinta-se à vontade para contribuir com uma solução para o seu shell preferido.

Recursos de integração do shell

Abrir novas guias no mesmo diretório de trabalho

Abrir novas guias no mesmo diretório de trabalho

Mostrar marcas para cada comando na barra de rolagem

Mostrar marcas para cada comando na barra de rolagem

Saltar automaticamente entre comandos

Isso usa as ações scrollToMark como as definimos acima.

Saltar automaticamente entre comandos

Selecionar a saída inteira de um comando

Neste gif, usamos a ação selectOutput associada a ctrl+g para selecionar toda a saída de um comando. Selecionar a saída inteira de um comando

O mostrado a seguir usa a configuração experimental.rightClickContextMenu para habilitar um menu de contexto de clique com o botão direito do mouse no Terminal. Com essa integração de shell habilitada, você pode clicar com o botão direito do mouse em um comando para selecionar todo o comando ou a saída dele.

Selecionar o comando usando o menu de contexto de clique com botão direito

Sugestões de comando recentes

Com a integração do shell habilitada, a interface do usuário de Sugestões pode ser configurada para mostrar também seus comandos recentes.

A interface do usuário de sugestões mostrando comandos recentes nela

Você pode abrir este menu com a seguinte ação:

{
    "command": { "action": "showSuggestions", "source": "recentCommands", "useCommandline": true },
},

(Para obter mais informações, consulte a Documentação de sugestões)

Recursos adicionais