Português do Brasil
Appearance
Português do Brasil
Appearance
Embora o Starship seja um shell versátil, às vezes é necessário fazer mais do que editar o starship.toml
para que ele realize certas funções. Esta página detalha algumas das técnicas de configuração avançadas utilizadas no starship.
::: atenção
As configurações nesta seção estão sujeitas a alterações em futuras versões do Starship.
:::
É possível substituir o prompt anteriormente impresso por uma string personalisada. Isto é útil quando todas as informações do prompt não são nescessárias sempre. Para habilitar isto, execute Enable-TransientPrompt
na sessão do shell. Para ser permanente, adicione esta declaração no seu $PROFILE
. A transição pode ser desativada com Disable-TransientPrompt
.
Por padrão, o lado esquerdo da entrada é substituida por >
. Para personalizar isso defina uma nova função chamada Invoke-Starship-TransientFunction
. Por exemplo, para mostrar o módulo de caractere do Starship's
aqui, você faria
function Invoke-Starship-TransientFunction {
&starship module character
}
Invoke-Expression (&starship init powershell)
Enable-TransientPrompt
Clink permite você substituir o prompt anteriormente impresso com strings personalizadas. Isto é útil quando todas as informações do prompt não são nescessárias sempre. Para habilitar isso, execute clink set prompt.transient <value>
onde <value> pode ser um dos:
always
: sempre substitui o prompt anteriorsame_dir
: substitui o prompt anterior apenas se o diretório de trabalho for o mesmooff
: não substitui o prompt (ou seja, desliga a transição)Você precisa fazer isso apenas uma vez. Faça as seguintes alterações ao seu starship.lua
para personalizar o que é exibido à esquerda e à direita:
>
. Para personalizar isso, defina uma nova função chamada starship_transient_prompt_func
. Esta função recebe o prompt atual como uma string que você pode utilizar. Por exemplo, para mostrar o módulo de caractere do Starship's
aqui, você fariafunction starship_transient_prompt_func(prompt)
return io.popen("starship module character"
.." --keymap="..rl.getvariable('keymap')
):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
starship_transient_rprompt_func
. Esta função recebe a prompt atual de como uma string que você pode utilizar. Por exemplo, para exibir o momento em que o último comando foi iniciado, você fariafunction starship_transient_rprompt_func(prompt)
return io.popen("starship module time"):read("*a")
end
load(io.popen('starship init cmd'):read("*a"))()
É possível substituir o prompt anteriormente impresso por uma string personalisada. Isto é útil quando todas as informações do prompt não são nescessárias sempre. Para habilitar isso, execute enable_transience
na sessão do shell. Para torná-lo permanente, coloque esta declaração no seu ~/.config/fish/config.fish
. Transição pode ser desativada com disable_transience
.
Observe que, no caso do Fish, o prompt transitório só será impresso se a linha de comando não estiver vazia, e sintaticamente correta.
❯
verde. Para personalizar isso, defina uma nova função chamada starship_transient_prompt_func
. Por exemplo, para mostrar o módulo de caractere do Starship's
aqui, você fariafunction starship_transient_rprompt_func
starship module time
end
starship init fish | source
enable_transience
starship_transient_rprompt_func
. Por exemplo, para exibir o momento em que o último comando foi iniciado, você fariafunction starship_transient_rprompt_func
starship module time
end
starship init fish | source
enable_transience
O framework Ble.sh na versão 0.4 ou superior permite substituir o prompt exibido anteriormente por strings personalizadas. Isso é útil em casos onde todas as informações do prompt não são sempre necessárias. Para habilitar isso, coloque em ~/.bashrc
bleopt prompt_ps1_transient=<value>
:
O <value> aqui é uma lista separada por dois pontos de always
, same-dir
e trim
. Quando prompt_ps1_final
está vazio e a opção prompt_ps1_transient
tem um \ não vazio <value>, o prompt especificado por PS1
é apagado ao sair da linha de comando atual. Se <value> contiver um campo trim
, apenas a última linha da multilinha PS1
será preservada e as outras linhas serão apagadas. Caso contrário, a linha de comando será redesenhada como se PS1=
fosse especificado. Quando um campo same-dir
está contido em <value> e o diretório atual é diferente do diretório final da linha de comando anterior, esta opção prompt_ps1_transient
é ignorada.
Faça as seguintes alterações no seu ~/.blerc
(ou em ~/.config/blesh/init.sh
) para personalizar o que é exibido à esquerda e à direita:
prompt_ps1_final
Ble.sh. Por exemplo, para exibir o módulo caractere
do Starship aqui, você deve fazerbleopt prompt_ps1_final='$(starship module character)'
prompt_rps1_final
Ble.sh. Por exemplo, para exibir o momento em que o último comando foi iniciado, você deve fazerbleopt prompt_rps1_final='$(starship module time)'
O Clink fornece APIs extremamente flexíveis para executar comandos pré-prompt e pré-execução em Cmd shell. É bastante simples de usar com o Starship. Faça as seguintes alterações no seu arquivo starship.lua
conforme suas necessidades:
starship_preprompt_user_func
. Esta função recebe o prompt atual como uma string que você pode utilizar. Por exemplo, para exibir um foguete antes do prompt, você fariafunction starship_preprompt_user_func(prompt)
print("🚀")
end
load(io.popen('starship init cmd'):read("*a"))()
starship_precmd_user_func
. Esta função recebe a linha de comando atual como uma string que você pode utilizar. Por exemplo, para imprimir o comando que está prestes a ser executado, você fariafunction starship_precmd_user_func(line)
print("Executing: "..line)
end
load(io.popen('starship init cmd'):read("*a"))()
Bash não possui uma estrutura formal pré-prompt/pré-execução como a maioria dos outros shells. Por causa disso, é difícil fornecer ganchos totalmente personalizáveis no bash
. No entanto, Starship te oferece uma capacidade limitada de inserir suas próprias funções na processo de prompt-rendering:
starship_precmd_user_func
. Por exemplo, para exibir um foguete antes do prompt, você fariafunction blastoff(){
echo "🚀"
}
starship_precmd_user_func="blastoff"
DEBUG
mecanismo de captura. No entanto, você deve capturar o sinal DEBUG antes de inicializar o Starship! Starship pode preservar o valor da captura do DEBUG, mas se a captura for substituída após a inicialização do starship, algumas funcionalidades serão interrompidas.function blastoff(){
echo "🚀"
}
trap blastoff DEBUG # Captura o DEBUG *antes* de executar a nave estelar
set -o functrace
eval $(starship init bash)
set +o functrace
PowerShell não possui uma estrutura formal pré-prompt/pré-execução como a maioria dos outros shells. Por causa disso, é difícil fornecer ganchos totalmente personalizáveis no powershell
. No entanto, Starship te oferece uma capacidade limitada de inserir suas próprias funções na processo de prompt-rendering:
Crie uma função chamada Invoke-Starship-PreCommand
function Invoke-Starship-PreCommand {
$host.ui.Write("🚀")
}
Alguns prompts do shell alterarão automaticamente o título da janela para você (ex., para refletir no seu diretório de trabalho). Fish ainda faz isso por padrão. Starship não faz isso, mas é bastante simples adicionar essa funcionalidade para bash
, zsh
, cmd
ou powershell
.
Primeiro, defina uma função de mudança de título da janela (idêntica em bash e zsh):
function set_win_title(){
echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
}
Você pode usar variáveis para personalizar este título ($USER
, $HOSTNAME
e $PWD
são escolhas populares).
No bash
, defina esta função como a função precmd da nave estelar:
starship_precmd_user_func="set_win_title"
No zsh
, adicione isso ao array precmd_functions
:
precmd_functions+=(set_win_title)
Se você gostar do resultado, adicione estas linhas ao seu arquivo de configuração do shell (~/.bashrc
ou ~/.zshrc
) para torná-lo permanente.
Por exemplo, se você deseja exibir seu diretório atual no título da guia do terminal, adicione o seguinte trecho ao seu ~/.bashrc
ou ~/.zshrc
:
function set_win_title(){
echo -ne "\033]0; $(basename "$PWD") \007"
}
starship_precmd_user_func="set_win_title"
Para Cmd, você pode alterar o título da janela usando a função starship_preprompt_user_func
.
function starship_preprompt_user_func(prompt)
console.settitle(os.getenv('USERNAME').."@"..os.getenv('COMPUTERNAME')..": "..os.getcwd())
end
load(io.popen('starship init cmd'):read("*a"))()
Você também pode definir uma saída semelhante com o PowerShell criando uma função chamada Invoke-Starship-PreCommand
.
# editar $PROFILE
function Invoke-Starship-PreCommand {
$host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a"
}
Invoke-Expression (&starship init powershell)
Alguns shells suportam um prompt direito que é renderizado na mesma linha que a entrada. Starship pode definir o conteúdo do prompt correto usando a opção right_format
. Qualquer módulo que pode ser usado no format
também é compatível com right_format
. A variável $all
conterá apenas módulos não usado explicitamente em format
ou right_format
.
Nota: O prompt direito é uma única linha após o local de entrada. Para alinhar à direita os módulos acima da linha de entrada em um prompt de várias linhas, consulte o módulofill
.
right_format
é atualmente suportado para os seguintes shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.
Nota: O framework Ble.sh na versão 0.4 ou superior deve estar instalado para utilizar o prompt direito no bash.
# ~/.config/starship.toml
# Um prompt mínimo à esquerda
format = """$character"""
# movw o restante do prompt para a direita
right_format = """$all"""
Produz um prompt como o seguinte:
▶ starship on rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
Alguns shells suportam um prompt de continuação junto com o prompt normal. Esse prompt é renderizado em vez do prompt normal quando o usuário insere uma instrução incompleta (como um único parêntese esquerdo ou aspas).
Starship pode definir o prompt de continuação usando a opção continuation_prompt
. O prompt padrão é '[∙](bright-black) '
.
Nota: continuation_prompt
deve ser definido como uma string literal sem nenhuma variável.
Nota: os prompts de continuação estão disponíveis apenas nos seguintes shells:
bash
zsh
PowerShell
# ~/.config/starship.toml
# Um prompt de continuação que exibe duas setas preenchidas
continuation_prompt = '▶▶ '
As strings de estilo são uma lista de palavras, separadas por espaços em branco. As palavras não diferenciam maiúsculas de minúsculas (ou seja, bold
e BoLd
são considerados a mesma string). Cada palavra pode ser as seguintes:
bold
italic
underline
dimmed
inverted
blink
hidden
strikethrough
bg:<color>
fg:<color>
<color>
none
onde <color>
é um especificador de cor (discutido abaixo). fg:<color>
e <color>
atualmente fazem a mesma coisa, embora isso possa mudar no futuro. <color>
também pode ser configurado para prev_fg
ou prev_bg
, que avaliam a cor de primeiro plano ou de fundo do item anterior, respectivamente, se disponível, ou none
caso contrário. inverted
troca as cores de fundo e primeiro plano. A ordem das palavras na string não importa.
O token none
substitui todos os outros tokens em uma string se não fizer parte de um especificador bg:
, de modo que, ex., fg:red none fg:blue
ainda criará uma string sem estilo. bg:none
define o plano de fundo para a cor padrão para que fg:red bg:none
seja equivalente a red
ou fg:red
e bg:green fg:red bg:none
também é equivalente a fg:red
ou red
. Pode ser um erro usar none
em conjunto com outros tokens no futuro.
Um especificador de cor pode ser um dos seguintes:
black
, red
, green
, blue
, yellow
, purple
, cyan
, white
. Você pode, opcionalmente, prefixar esses com bright-
para obter a versão brilhante/clara (por exemplo, bright-white
).#
seguido por um número hexadecimal de seis dígitos. Especifica um Código hexadecimal de cor RGB.Se várias cores forem especificadas para primeiro plano/plano de fundo, a última na string terá prioridade.
Nem todas os estilos de string serão exibidos corretamente em todos terminais. Em particular, existem os seguintes erros conhecidos:
blink
.hidden
não é suportado no iTerm.strikethrough
não é suportado por padrão no aplicativo de terminal do macOS.