182 KiB
Configuração
Para começar a configurar a starship, crie o seguinte arquivo: ~/.config/starship.toml.
mkdir -p ~/.config && touch ~/.config/starship.toml
Todas as configurações do starship são feitas neste arquivo TOML:
#Insere uma linha vazia entre os prompts
add_newline = true
# Substitui o simbolo "❯" do prompt por "➜"
[character] # O nome do módulo que nos estamos configurando é "character"
success_symbol = "[➜](bold green)" # O seguimento do "success_symbol" é alterado para "➜" com a cor "bold green"
# Desabilita o módulo de package, ocultando completamente do prompt
[package]
disabled = true
Você pode alterar o caminho padrão do arquivo de configuração com a variável de ambiente STARSHIP_CONFIG:
export STARSHIP_CONFIG=~/.starship/config.toml
No PowerShell (Windows) você pode adicionar a seguinte linha no seu $PROFILE:
$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
Logging
Por padrão o starship grava logs de erros e warnings dentro de um arquivo chamado ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log, onde a session key corresponde a instancia do seu terminal. Isto, no entanto pode ser alterado usando a variável de ambiente STARSHIP_CACHE:
export STARSHIP_CACHE=~/.starship/cache
No PowerShell (Windows) você pode adicionar a seguinte linha no seu $PROFILE:
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
Terminologia
Módulo: Um componente no prompt que fornece informações baseado no contexto do seu SO. Por exemplo, o "nodejs"módulo exibe a versão do Node.js que está instalada no computador, se o diretório atual for um projeto Node.js.
Variável: Um pequeno subcomponente que contem informações fornecidas pelo módulo. Por exemplo, a variável "version" no módulo "nodejs"contem a versão atual do Node.js.
Por convenção, a maioria dos módulos tem um prefixo de cor (e.x. via no "nodejs") e um espaço vazio para sufixo.
Formatação de Strings
Formatar uma string é a forma de como o módulo ira imprimir suas variáveis. A maioria dos módulos tem uma entrada chamada format que configura o formato que o módulo é exibido. Você pode usar textos, variáveis e grupo de textos em uma formatação de string.
Variável
Uma variável contem um simbolo $ seguido pelo nome da variável. O nome da variável contem apenas letras, números e _.
Por exemplo:
$versioné uma formatação de string com uma variável chamadaversion.$git_branch$git_commité uma formatação de string com duas variáveis chamadasgit_branchegit_commit.$git_branch $git_commitTem as duas variáveis separadas por espaço.
Grupo de Texto
Um grupo de texto é composto por duas partes diferentes.
A primeira parte, é contida em um [], é uma formatação de string. Você pode adicionar textos, variáveis ou até mesmos grupo de textos aninhados.
Na segunda parte, é composta por um (), é uma estilização de string. This can be used to style the first part.
Por exemplo:
[on](red bold)vai imprimir uma stringoncom texto em negrito e com a cor vermelha.[⌘ $version](bold green)vai imprimir o simbolo⌘seguido pela variávelversion, com o texto em negrito e na cor verde.[a [b](red) c](green)vai imprimira b ccombvermelho, eaecverde.
Estilo dos textos
A maioria dos módulos do starship permite que você configure o estilo de exibição dos textos. Isso é feito através de um parâmetro (geralmente chamado style) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo e o que elas fazem. Para detalhes sobre a sintaxe completa, consulte o guia de configurações avançadas.
"fg:green bg:blue"deixa o texto verde com o fundo azul"bg:blue fg:bright-green"deixa o texto verde brilhante com o fundo azul"bold fg:27"deixa o texto em negrito com a cor 27 da tabela ANSI"underline bg:#bf5700"deixa o texto sublinhado com o fundo laranja escuro"bold italic fg:purple"deixa o texto em negrito e itálico com a cor roxa""desabilita explicitamente todos os estilos
Note que a aparência do estilo será controlado pelo seu terminal. Por exemplo, alguns terminais deixarão as cores mais brilhantes ao invés de deixar o texto em negrito, ou alguns temas podem usar as mesmas cores para cores brilhantes e normais. Além disso, para textos em itálico, o terminal precisa ter suporte.
Formatação de String Condicional
Uma formatação condicional de string é envolto por ( e ) não vai ser exibido caso a variável dentro esteja vazia.
Por exemplo:
(@$region)não vai exibir nada caso a variávelregionsejaNoneou vazia, caso contrario vai exibir@seguido pelo valor da variável region.(texto qualquer)não vai exibir nada sempre, pois não existe variável entre os parenteses.- Quando usar
$allé um atalho para\[$a$b\],($all)vai exibir nada somente quando$ae$bsãoNone. Isto funciona da mesma forma que(\[$a$b\] ).
Caractere de escape
Os símbolos a seguir tem uso especial em uma formatação de string. Se você quer imprimir os símbolos a seguir você deve adicionar uma barra invertida (\).
- $
- \
- [
- ]
- (
- )
Observe que toml tem sua própria sintaxe de escape. É recomendado usar uma string literal ('') no seu arquivo de configuração. Se você quer usar uma string básica (""), preste atenção ao usar a barra invertida \.
Por exemplo, quando você quer imprimir um simbolo $ em uma nova linha, as configurações de format a seguir são equivalentes:
# com string básica
format = "\n\\$"
# com múltiplas linhas de string básica
format = """
\\$"""
# com string literal
format = '''
\$'''
Prompt de Comando
Está é a lista de opções de configuração de prompt.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
link | Configura o formato do prompt. |
right_format |
"" |
See Enable Right Prompt |
scan_timeout |
30 |
Tempo limite para escanear arquivos (em milissegundos). |
command_timeout |
500 |
Tempo limite de execução de comandos pelo starship (em milissegundos). |
add_newline |
true |
Insere linha vazia entre os prompts do shell. |
Exemplo
# ~/.config/starship.toml
# Usa um format customizado
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """
#Espera 10 milissegundos para que o starship check os arquivos do diretório atual.
scan_timeout = 10
# Desabilita uma nova linha no inicio do prompt
add_newline = false
Format de Prompt Padrão
O formato padrão é usado para definir o formato do prompt, se um valor vazio ou não formatado for informado. Os valores padrão são os seguintes:
format = "$all"
# Which is equivalent to
format = """
$username\
$hostname\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$cobol\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$lua\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$pulumi\
$purescript\
$python\
$rlang\
$red\
$ruby\
$rust\
$scala\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$custom\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""
If you just want to extend the default format, you can use $all; modules you explicitly add to the format will not be duplicated. Eg.
# Move the directory to the second line
format="$all$directory$character"
AWS
O módulo aws exibi a região e perfil atual do AWS. Isto é baseado nas variáveis de env AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE contidas no arquivo ~/.aws/config. Este modulo exibi também tempo de expiração de credenciais temporarias.
Quando usar aws-vault o perfil é lido da variável AWS_VAULT e o tempo de expiração de credenciais é lida da variável de env AWS_SESSION_EXPIRATION.
Quando usar awsu o perfil é lido da varável de env AWSU_PROFILE.
Quando usar AWSume o perfil é lido da variável AWSUME_PROFILE e o tempo de expiração de credenciais é lida da variável de env AWSUME_EXPIRATION.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)' |
O formato do módulo. |
symbol |
"☁️ " |
O símbolo usado antes de exibir o perfil atual da AWS. |
region_aliases |
Tabela de aleases de regiões a serem exibidas, além do nome da AWS. | |
style |
"bold yellow" |
O estilo do módulo. |
expiration_symbol |
X |
O simbolo exibido quando as credenciais temporárias estão expiradas. |
disabled |
false |
Desabilita o modulo AWS. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| region | ap-northeast-1 |
A região atual do AWS |
| profile | astronauts |
O perfil atual do AWS |
| duration | 2h27m20s |
A duração temporária das credenciais |
| symbol | Espelha o valor da opção símbolo |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplos
Exibir tudo
# ~/.config/starship.toml
[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
Exibir região
# ~/.config/starship.toml
[aws]
format = "on [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
Exibir perfil
# ~/.config/starship.toml
[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "
Bateria
O módulo battery exibe o quanto a bateria do dispositivo está carregada e o estado atual de carregamento. O módulo é visível somente quando a bateria está abaixo de 10%.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
full_symbol |
" " |
O simbolo exibido quando a bateria estiver cheia. |
charging_symbol |
" " |
O simbolo exibido quando a bateria está carregando. |
discharging_symbol |
" " |
O simbolo exibido quando a bateria está descarregando. |
unknown_symbol |
" " |
O simbolo exibido quando o estado da bateria é desconhecido. |
empty_symbol |
" " |
O simbolo exibido quando o estado da bateria é vazio. |
format |
"[$symbol$percentage]($style) " |
O formato do módulo. |
display |
link | Limite de exibição e estilo para o módulo. |
disabled |
false |
Desabilita o módulo battery. |
Exemplo
# ~/.config/starship.toml
[battery]
full_symbol = "🔋 "
charging_symbol = "⚡️ "
discharging_symbol = "💀 "
Indicador de bateria
A configuração display é usada para definir quando o indicador de bateria deve ser exibido (threshold), qual deve ser o simbolo(symbol) e como você gostaria de exibir (style). Se nenhum display for fornecido. Os valores padrão são os seguintes:
[[battery.display]]
threshold = 10
style = "bold red"
O valor padrão das opções charging_symbol e discharging_symbolé respectivamente o valor das opções battery's charging_symbol e discharging_symbol.
Opções
A opção display é um array da seguinte tabela.
| Opções | Padrão | Descrição |
|---|---|---|
threshold |
10 |
O limite superior para exibição. |
style |
bold red |
O estilo usado para exibir quando estiver em uso. |
charging_symbol |
- |
Simbolo opcional, mostrado quando a opção estiver em uso, o simbolo padrão é charging_symbol. |
discharging_symbol |
- |
Simbolo opcional, mostrado quando a opção estiver em uso, o simbolo padrão é discharging_symbol. |
Exemplo
[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = "bold yellow"
discharging_symbol = "💦"
# when capacity is over 30%, the battery indicator will not be displayed
Caractere
O módulo character exibe um caracter (normalmente uma seta) ao lado de onde o texto começa a ser inserido no terminal.
O caractere vai te dizer se o ultimo comando foi bem sucedido ou não. Você pode fazer isto de duas maneiras:
- alterando a cor (
red/green) - alterando a forma (
❯/✖)
Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olhada neste exemplo.
::: warning
error_symbol não é suportado no elvish e nu shell.
:::
::: warning
vicmd_symbol é suportado apenas no fish e zsh.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"$symbol" |
O formato da string usado antes da entrada dos textos. |
success_symbol |
"[❯](bold green)" |
O formato da string usado antes da entrada de texto se o comando anterior for bem-sucedido. |
error_symbol |
"[❯](bold red)" |
O formato de string usado antes da entrada de texto se o comando anterior tiver falhado. |
vicmd_symbol |
"[❮](bold green)" |
O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. |
disabled |
false |
Desabilita o módulo character. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| symbol | Um espelho de success_symbol, error_symbol ou vicmd_symbol |
Exemplos
Com formas customizadas de erro
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "
Sem formas customizadas de erro
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "
Com formas customizadas no vim
# ~/.config/starship.toml
[character]
vicmd_symbol = "[V](bold green) "
CMake
O módulo cmake exibe a versão instalada do CMake. Por padrão o módulo será ativo se qualquer das condições a seguir for atendida:
- O diretorio atual cotem um arquivo
CMakeLists.txt - O diretorio atual tem um arquivo
CMakeCache.txt
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"△ " |
O simbolo usado antes da versão do cmake. |
detect_extensions |
[] |
Quais extensões devem acionar este módulo |
detect_files |
["CMakeLists.txt", "CMakeCache.txt"] |
[] |
detect_folders |
[] |
Quais pastas devem ativar este módulo |
style |
"bold blue" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo cmake. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v3.17.3 |
A versão do cmake |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
COBOL / GNUCOBOL
The cobol module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:
- The current directory contains any files ending in
.cobor.COB - The current directory contains any files ending in
.cblor.CBL
Opções
| Opções | Padrão | Descrição |
|---|---|---|
symbol |
"⚙️ " |
The symbol used before displaying the version of COBOL. |
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
style |
"bold blue" |
O estilo do módulo. |
detect_extensions |
["cbl", "cob", "CBL", "COB"] |
Quais extensões devem ativar este módulo. |
detect_files |
[] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
disabled |
false |
Disables the cobol module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v3.1.2.0 |
The version of cobol |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Tempo de execução do comando
O módulo cmd_duration exibi o tempo que o ultimo comando levou para executar. O módulo vai exibir somente se o comando levar mais de dois segundos, ou o valor de configuração min_time existir.
::: warning Não utilize o DEBUG-trap no Bash
Se você esta rodando o Starship no bash, você não deve ativar a armadilha DEBUG após rodar eval $(starship init $0), ou este módulo vai quebrar.
:::
Usuários do bash que precisam de funções pre-executadas podem usar rcaloras's bash_preexec framework. Simplesmente defina os arrays preexec_functions e precmd_functions antes de rodar eval $(starship init $0), e depois pode proceder normalmente.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
min_time |
2_000 |
Duração mais curta para exibir o tempo (em milissegundos). |
show_milliseconds |
false |
Exibir milissegundos ou invés de segundos para duração. |
format |
"took [$duration]($style) " |
O formato do módulo. |
style |
"bold yellow" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo cmd_duration. |
show_notifications |
false |
Exibi notificações no desktop quando o comando for concluído. |
min_time_to_notify |
45_000 |
Tempo minimo para notificação (em milissegundos). |
::: tip
Para exibir notificações requer que o starship seja construído com suporte para rust-notify. Você consegue verificar se seu starship suporta notificações rodando STARSHIP_LOG=debug starship module cmd_duration -d 60000 quando show_notifications é definido como true.
:::
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| duration | 16m40s |
O tempo que levou para executar o comando |
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[cmd_duration]
min_time = 500
format = "underwent [$duration](bold yellow)"
Conda
The conda module shows the current Conda environment, if $CONDA_DEFAULT_ENV is set.
::: tip
Isso não suprime o modificador de prompt do conda, você pode executar conda config --set changeps1 False.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
truncation_length |
1 |
O número de diretórios do envirionment path deve ser truncado, se o environment foi criado via conda create -p [path]. 0 quer dizer sem truncação. Também consulte o módulo directory. |
symbol |
"🅒 " |
O simbolo usado antes do nome do environment. |
style |
"bold green" |
O estilo do módulo. |
format |
"via [$symbol$environment]($style) " |
O formato do módulo. |
ignore_base |
true |
Ignora o environment base quando ativado. |
disabled |
false |
Desabilita o módulo conda. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| environment | astronauts |
O environment atual do conda |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[conda]
format = "[$symbol$environment](dimmed green) "
Crystal
O módulo crystal exibe a versão instalada atual do Crystal. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
shard.yml - O diretório atual contem um arquivo
.cr
Opções
| Opções | Padrão | Descrição |
|---|---|---|
symbol |
"🔮 " |
O simbolo usado antes de exibir a versão do crystal. |
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
style |
"bold red" |
O estilo do módulo. |
detect_extensions |
["cr"] |
Quais extensões devem ativar este módulo. |
detect_files |
["shard.yml"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
disabled |
false |
Desabilita o módulo crystal. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v0.32.1 |
A versão do crystal |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[crystal]
format = "via [✨ $version](bold blue) "
Dart
O módulo dart exibe a versão atual instalada do Dart. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem algum arquivo com extensão
.dart - O diretório atual contem um diretório
.dart_tool - O diretório atual contem um arquivo
pubspec.yaml,pubspec.ymloupubspec.lock
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🎯 " |
Um formato de string que representa o simbolo do Dart |
detect_extensions |
["dart"] |
Quais extensões devem ativar este módulo. |
detect_files |
["pubspec.yaml", "pubspec.yml", "pubspec.lock"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[".dart_tool"] |
Quais pastas devem ativar este módulo. |
style |
"bold blue" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo dart. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v2.8.4 |
The version of dart |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[dart]
format = "via [🔰 $version](bold red) "
Deno
O módulo deno exibe a versão instalada atual do Deno. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório contem um arquivo
mod.ts,mod.js,deps.tsoudeps.js
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🦕 " |
Um formato de string que representa o simbolo do Deno |
detect_extensions |
[] |
Quais extensões devem ativar este módulo. |
detect_files |
["mod.ts", "mod.js", "deps.ts", "deps.js"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"green bold" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo deno. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.8.3 |
A versão do deno |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
Exemplo
# ~/.config/starship.toml
[deno]
format = "via [🦕 $version](green bold) "
Diretório
O módulo directory exibe o caminho do diretório atual, truncando as três pastas pai. Seu diretório será truncando na raiz do repositório git que você estiver atualmente.
Quando usar a opção de estilo fish pwd, ao invés de esconder o caminho que é truncado, você vai ver um nome encurtado de cada diretório baseado no número que você habilitar para a opção.
Por exemplo, dado ~/Dev/Nix/nixpkgs/pkgs onde nixpkgs é o repositório raiz e a opção esta definida para 1. Você verá ~/D/N/nixpkgs/pkgs, enquanto antes seria nixpkgs/pkgs.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
truncation_length |
3 |
O número de pastas pais do diretório atual que serão truncadas. |
truncate_to_repo |
true |
Seu diretório será truncado ou não para a raiz do repositório git atual. |
format |
"[$path]($style)[$read_only]($read_only_style) " |
O formato do módulo. |
style |
"bold cyan" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo directory. |
read_only |
"🔒" |
O simbolo que indica que o diretório atual é somente leitura. |
read_only_style |
"red" |
O estilo para o simbolo de somente leitura. |
truncation_symbol |
"" |
O simbolo para prefixo de caminhos truncados. ex: "…/" |
repo_root_style |
None |
The style for the root of the git repo when truncate_to_repo option is set to false. |
home_symbol |
"~" |
The symbol indicating home directory. |
Este módulo tem algumas configurações avançadas que controlam como o diretório é exibido.
| Advanced Option | Padrão | Descrição |
|---|---|---|
substitutions |
A table of substitutions to be made to the path. | |
fish_style_pwd_dir_length |
0 |
The number of characters to use when applying fish shell pwd path logic. |
use_logical_path |
true |
If true render the logical path sourced from the shell via PWD or --logical-path. If false instead render the physical filesystem path with symlinks resolved. |
substitutions allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.
[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"
fish_style_pwd_dir_length interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll, which would normally be displayed as as rock/and/roll, would be displayed as /b/t/c/o/rock/and/roll with fish_style_pwd_dir_length = 1--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2, it would be /bu/th/ci/on/rock/and/roll.
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| path | "D:/Projects" |
O caminho do diretório atual |
| style* | "black bold dimmed" |
Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[directory]
truncation_length = 8
truncation_symbol = "…/"
Docker Context
The docker_context module shows the currently active Docker context if it's not set to default or if the DOCKER_MACHINE_NAME, DOCKER_HOST or DOCKER_CONTEXT environment variables are set (as they are meant to override the context in use).
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol$context]($style) " |
O formato do módulo. |
symbol |
"🐳 " |
O simbolo usado antes de exibir a versão do contexto docker. |
only_with_files |
true |
Exibe somente quando houver um arquivo |
detect_extensions |
[] |
Quais extensões devem acionar este módulo (precisa que only_with_files seja true). |
detect_files |
["docker-compose.yml", "docker-compose.yaml", "Dockerfile"] |
Quais arquivos devem acionar este módulo (precisa que only_with_files seja true). |
detect_folders |
[] |
Quais pastas devem acionar este módulo (precisa que only_with_files seja true). |
style |
"blue bold" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo docker_context. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| context | test_context |
O contexto atual do docker |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[docker_context]
format = "via [🐋 $context](blue bold)"
Dotnet
O módulo dotnet exibe a versão relevante do .NET Core SDK para a pasta atual. Se o SDK foi fixado na pasta atual, a versão será exibida. Caso contrario será exibida a ultima versão instalada do SDK.
Por padrão o módulo vai apenas exibir no seu prompt quando um ou mais dos seguintes arquivos estiverem presente no diretório:
global.jsonproject.jsonDirectory.Build.propsDirectory.Build.targetsPackages.props*.csproj*.fsproj*.xproj
Você também precisa do .NET Core SDK instalado para usá-lo corretamente.
Internamente, este módulo usa seu próprio mecanismo de detecção de versão. Normalmente é duas vezes mais rápido que executar dotnet --version, mas pode exibir uma versão errado se o projeto .NET tiver o layout de diretório incomum. Se a precisão é mais importante que velocidade, você pode desabilitar o mecanismo definindo heuristic = false nas opções do modulo.
O módulo também vai exibir o Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) quando o diretório atual tiver o arquivo csproj.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )(🎯 $tfm )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
".NET " |
O simbolo usado antes de exibir a versão do dotnet. |
heuristic |
true |
Usa a versão de detecção rápida do starship snappy. |
detect_extensions |
["csproj", "fsproj", "xproj"] |
Quais extensões devem ativar este módulo. |
detect_files |
["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"bold blue" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo dotnet. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v3.1.201 |
A versão do sdk dotnet |
| tfm | netstandard2.0 |
O framework alvo do projeto atual |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
Elixir
O módulo elixir exibe a versão instalada do Elixir e Erlang/OTP. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
mix.exs.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
'via [$symbol($version \(OTP $otp_version\) )]($style)' |
O formato do módulo elixir. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"💧 " |
O simbolo usado antes de exibir a versão do Elixir/Erlang. |
detect_extensions |
[] |
Quais extensões devem ativar este módulo. |
detect_files |
["mix.exs"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"bold purple" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo elixir. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.10 |
A versão do elixir |
| otp_version | A versão otp do elixir |
|
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
Elm
O módulo elm exibe a versão instalada do Elm. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
elm.json - O diretório atual contem o arquivo
elm-package.json - O diretório atual contem um arquivo
.elm-version - O diretório atual contem uma pasta
elm-stuff - O diretório contem arquivos
*.elm
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🌳 " |
O formato de string que representa o simbolo do Elm. |
detect_extensions |
["elm"] |
Quais extensões devem ativar este módulo. |
detect_files |
["elm.json", "elm-package.json", ".elm-version"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
["elm-stuff"] |
Quais pastas devem ativar este módulo. |
style |
"cyan bold" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo elm. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v0.19.1 |
A versão do elm |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
[elm]
format = "via [ $version](cyan bold) "
Variáveis de Ambiente
O módulo env_var exibe o valor atual de uma variável de ambiente selecionada. O módulo vai exibir somente se algumas das condições a seguir for atendida:
- A opção de configuração da
variablecorresponde a uma variável existente - A configuração
variablenão está definida, mas adefaultestá
::: tip Varias variáveis podem ser exibidas usando um .. (Veja o exemplo) se a configuração variable não é definida, o módulo irá exibir o valor da variável após o caractere ..
Exemplo: a configuração a seguir irá mostrar o valor da variável de ambiente USER
# ~/.config/starship.toml
[env_var.USER]
default = "unknown user"
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
symbol |
"" |
O simbolo usado antes de exibir o valor da variável. |
variable |
A variável de ambiente a ser exibida. | |
default |
O valor padrão para exibir quando a variável selecionada não estiver definida. | |
format |
"with [$env_value]($style) " |
O formato do módulo. |
disabled |
false |
Desabilita o módulo env_var. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| env_value | Windows NT (if variable would be $OS) |
O valor de ambiente da opção variable |
| symbol | Espelha o valor da opção symbol |
|
| style* | black bold dimmed |
Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[env_var]
variable = "SHELL"
default = "unknown shell"
Exibindo múltiplas variáveis de ambiente:
# ~/.config/starship.toml
[env_var.SHELL]
variable = "SHELL"
default = "unknown shell"
[env_var.USER]
default = "unknown user"
Erlang
O módulo de erlang exibe a versão atual instalada do Erlang/OTP. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
rebar.config. - O diretório atual contem um arquivo
erlang.mk.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
" " |
O simbolo usado antes de exibir a versão do erlang. |
style |
"bold red" |
O estilo do módulo. |
detect_extensions |
[] |
Quais extensões devem ativar este módulo. |
detect_files |
["rebar.config", "elang.mk"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
disabled |
false |
Desabilita o módulo erlang. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v22.1.3 |
A versão do erlang |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[erlang]
format = "via [e $version](bold red) "
Fill
The fill module fills any extra space on the line with a symbol. If multiple fill modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
symbol |
"." |
The symbol used to fill the line. |
style |
"bold black" |
O estilo do módulo. |
disabled |
false |
Disables the fill module |
Exemplo
# ~/.config/starship.toml
format="AA $fill BB $fill CC"
[fill]
symbol = "-"
style = "bold green"
Produces a prompt that looks like:
AA -------------------------------------------- BB -------------------------------------------- CC
Google Cloud (gcloud)
O módulo gcloud exibe a configuração atual para o gcloud CLI. Isto é baseadp mp arquivo ~/.config/gcloud/active_config e no arquivo~/.config/gcloud/configurations/config_{CONFIG NAME} e a env var CLOUDSDK_CONFIG.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
'on [$symbol$account(@$domain)(\($region\))]($style) ' |
O formato do módulo. |
symbol |
"☁️ " |
O simbolo usado antes de exibir o perfil atual do GCP. |
region_aliases |
Tabela de aliases de região para exibir além do nome do GCP. | |
style |
"bold blue" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo gcloud. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| region | us-central1 |
A região atual do GCP |
| account | foo |
O perfil atual do GCP |
| domain | example.com |
O perfil de domínio atual do GCP |
| project | O projeto atual do GCP | |
| active | default |
O nome da configuração escrita em ~/.config/gcloud/active_config |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplos
Exibe conta e projeto
# ~/.config/starship.toml
[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
Exibe apenas o nome da configuração ativa
# ~/.config/starship.toml
[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"
Exibir conta e região
# ~/.config/starship.toml
[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"
Git Branch
O módulo git_branch exibe o branch ativo do repositório no diretório atual.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
always_show_remote |
false |
Exibe o nome do braço remoto, mesmo se ele for igual ao nome do braço local. |
format |
"on [$symbol$branch]($style) " |
O formato do módulo. Use "$branch" para se referir ao nome do braço atual. |
symbol |
" " |
Um formato de string que representa o simbolo do git branch. |
style |
"bold purple" |
O estilo do módulo. |
truncation_length |
2^63 - 1 |
Truncates um braço do git para N caracteres. |
truncation_symbol |
"…" |
O simbolo usado para indicar que o nome braço foi truncado. Você pode usar "" para sem simbolo. |
only_attached |
false |
Apenas exibe o nome do braço quando o estado não for detached HEAD. |
disabled |
false |
Desabilita o módulo git_branch. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| branch | master |
O nome do braço atual, retornará para HEAD se não tiver braço atual (e.x: git detached HEAD). |
| remote_name | origin |
O nome do remoto. |
| remote_branch | master |
O nome do braço rastreado no remote_name. |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""
Git commit
O módulo git_commit exibe o hash do comiit atual e também a tag (se existir) do repositório no diretório atual.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
commit_hash_length |
7 |
O tamanho do git commit hash para ser exibido. |
format |
"[\\($hash$tag\\)]($style) " |
O formato do módulo. |
style |
"bold green" |
O estilo do módulo. |
only_detached |
true |
Apenas exibe o git commit hash quando o estado for detached HEAD |
tag_disabled |
true |
Desabilita a exibição da informação da tag no módulo git_commit. |
tag_symbol |
" 🏷 " |
Simbolo da tag prefixado na informação a ser exibida |
disabled |
false |
Desabilita o módulo git_commit. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| hash | b703eb3 |
A hash atual do git commit |
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "
Git State
O módulo git_state vai exibir nos diretorios que fazem parte de um repositorio git e onde existe uma operação em progresso, como: REBASING, BISECTING, etc. Se houver informação de progresso (e.x: REBASING 3/10). esta informação será exibida também.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
rebase |
"REBASING" |
O formato de string exibida quando um rebase esta em progresso. |
merge |
"MERGING" |
O formato de string exibida quando um merge esta em progresso. |
revert |
"REVERTING" |
O formato de string exibida quando um revert esta em progresso. |
cherry_pick |
"CHERRY-PICKING" |
O formato de string exibida quando um cherry-pick esta em progresso. |
bisect |
"BISECTING" |
O formato de string exibida quando um bisect esta em progresso. |
am |
"AM" |
O formato de string exibida quando um apply-mailbox (git am) esta em progresso. |
am_or_rebase |
"AM/REBASE" |
O formato de string exibida quando um apply-mailbox or rebase esta em progresso. |
style |
"bold yellow" |
O estilo do módulo. |
format |
'\([$state( $progress_current/$progress_total)]($style)\) ' |
O formato do módulo. |
disabled |
false |
Desabilita o módulo git_state. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| state | REBASING |
O estado atual do repo |
| progress_current | 1 |
O progresso da operação atual |
| progress_total | 2 |
O total do progresso da operação atual |
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)"
Git Metrics
O módulo git_metrics vai exibir o número de adições e exclusões de linhas no repositório git atual.
::: tip
Este módulo é desativado por padrão. Para ativa-lo, defina disabled para false no seu arquivo de configuração.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
added_style |
"bold green" |
O estilo para a contagem de adições. |
deleted_style |
"bold red" |
O estilo para a contagem de exclusões. |
only_nonzero_diffs |
true |
Exibe apenas o status para itens alterados. |
format |
'([+$added]($added_style) )([-$deleted]($deleted_style) )' |
O formato do módulo. |
disabled |
true |
Desabilita o módulo git_metrics. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| added | 1 |
O número atual de linhas adicionadas |
| deleted | 2 |
O número atual de linhas excluidas |
| added_style* | Espelha o valor da opção added_style |
|
| deleted_style* | Espelha o valor da opçãodeleted_style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[git_metrics]
added_style = "bold blue"
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
Git Status
O módulo git_status exibe o simbolo que representa o estado do repositório no diretório atual.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
'([\[$all_status$ahead_behind\]]($style) )' |
O formato padrão para git_status |
conflicted |
"=" |
Este braço tem conflitos. |
ahead |
"⇡" |
O formato do ahead |
behind |
"⇣" |
O formato do behind |
diverged |
"⇕" |
O formato do diverged |
up_to_date |
"" |
O formato do up_to_date |
untracked |
"?" |
O formato do untracked |
stashed |
"$" |
O formato do stashed |
modified |
"!" |
O formato do modified |
staged |
"+" |
O formato do staged |
renamed |
"»" |
O formato do renamed |
deleted |
"✘" |
O formato do deleted |
style |
"bold red" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo git_status. |
Variáveis
As variáveis a seguir podem ser usadas no format:
| Variável | Descrição |
|---|---|
all_status |
Atalhos para $conflicted$stashed$deleted$renamed$modified$staged$untracked |
ahead_behind |
Exibe diverged, ahead, behind or up_to_date conforme o formato da string do status do repositório. |
conflicted |
Exibe conflicted quando este braço tenha conflitos no merge. |
untracked |
Exibe untracked quando há arquivos não rastreados no diretório atual. |
stashed |
Exibe stashed quando um stash existe para o repositório local. |
modified |
Exibe modified quando um arquivo tenha modificações for adicionado na área de staging. |
staged |
Exibe staged quando um arquivo novo for adicionado na área de staging. |
renamed |
Exibe renamed quando um arquivo renomeado for adicionado na área de staging. |
deleted |
Exibe deleted quando um arquivo deletado for adicionado na área de staging. |
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
As variáveis a seguir podem ser usadas em diverged:
| Variável | Descrição |
|---|---|
ahead_count |
Número de commits a frente do braço de rastreamento |
behind_count |
Número de commits atrás do braço de rastreamento |
As variaveis a seguir podem ser usadas em conflicted, ahead, behind, untracked, stashed, modified, staged, renamed e deleted:
| Variável | Descrição |
|---|---|
count |
Exibe o número de arquivos |
Exemplo
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
up_to_date = "✓"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"
Exibe o count a frente/atrás do braço que esta sendo rastreado
# ~/.config/starship.toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
Go
The golang module shows the currently installed version of Go. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
go.mod - O diretório atual contem um arquivo
go.sum - O diretório atual contem um arquivo
glide.yaml - O diretório atual contem um arquivo
Gopkg.yml - O diretório atual contém um arquivo
Gopkg.lock - O diretório atual contem um arquivo
.go-version - O diretório atual contem um diretório
Godeps - O diretório atual contem arquivos com a extensão
.go
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🐹 " |
O formato da string que representa o simbolo do Go. |
detect_extensions |
["go"] |
Quais extensões devem ativar este módulo. |
detect_files |
["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
["Godeps"] |
Quais pastas devem ativar este módulo. |
style |
"bold cyan" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo golang. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.12.1 |
A versão do go |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[golang]
format = "via [🏎💨 $version](bold cyan) "
Helm
O módulo helm exibe a versão atual instalada do Helm. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
helmfile.yaml - O diretório atual contem um arquivo
Chart.yaml
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
detect_extensions |
[] |
Quais extensões devem ativar este módulo. |
detect_files |
["helmfile.yaml", "Chart.yaml"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
symbol |
"⎈ " |
O formato de string que representa o simbolo do Helm. |
style |
"bold white" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo helm. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v3.1.1 |
A versão do helm |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[helm]
format = "via [⎈ $version](bold white) "
Hostname
O módulo hostname exibe o nome do hostname.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
ssh_only |
true |
Apenas exibe o hostname quando conectado em uma sessão SSH. |
trim_at |
"." |
String na qual vai truncar o hostname, após a primeira correspondência. "." vai truncar após o primeiro ponto. "" vai desabilitar qualquer truncação |
format |
"[$hostname]($style) in " |
O formato do módulo. |
style |
"bold dimmed green" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo hostname. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[hostname]
ssh_only = false
format = "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false
Java
O módulo java exibe o versão atual instalada do Java. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contenha algum dos arquivos
pom.xml,build.gradle.kts,build.sbt,.java-version,.deps.edn,project.clj, orbuild.boot - O diretório atual contenha arquivos com as extensões
.java,.class,.gradle,.jar,.clj, or.cljc
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
detect_extensions |
["java", "class", "gradle", "jar", "cljs", "cljc"] |
Quais extensões devem ativar este módulo. |
detect_files |
["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
symbol |
"☕ " |
Um formato de string que representa o simbolo do Java |
style |
"red dimmed" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo java. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v14 |
A versão do java |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[java]
symbol = "🌟 "
Jobs
O módulo jobs exibe o número atual de jobs rodando. O módulo vai ser exibido apenas se existir jobs em segundo plano sendo executados. O módulo vai exibir o número de jobs rodando se ao menos tiver 2 jobs ou mais que o valor da configuração number_threshold, se existir. O módulo vai exibir um simbolo se tiver ao menos 1 job ou mais, se o valor da configuração symbol_threshold existir. Você pode setar os dois valores para 0 para sempre exibir o simbolo e número de jobs, mesmo que seja 0 os jobs em execução.
A funcionalidade padrão é:
- 0 jobs -> Nada é exibido.
- 1 job ->
symbolé exibido. - 2 jobs or more ->
symbol+numberé exibido.
::: warning
Este módulo não é suportado em tcsh e nu.
:::
::: warning
A opção threshold está obsoleta, mas se você quiser usa-la, o módulo vai exibir o numero de jobs rodando se for maior que 1 ou maior que o valor configurado na threshold, se ele existir. Se o valor threshold for definido como 0, então o módulo vai exibir quando tiver 0 jobs rodando.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
threshold* |
1 |
Exibe o número de jobs se excedido. |
symbol_threshold |
1 |
Exibe symbol se o número de jobs for ao menos symbol_threshold. |
number_threshold |
2 |
Exibe o número de jobs se o número de jobs é ao menos number_threshold. |
format |
"[$symbol$number]($style) " |
O formato do módulo. |
symbol |
"✦" |
A string usada para representar a variável symbol. |
style |
"bold blue" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo jobs. |
| *: Esta opção está obsoleta, por favor use o |
number_threshold e symbol_threshold em vez disso.
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| number | 1 |
O número de jobs |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[jobs]
symbol = "+ "
number_threshold = 4
symbol_threshold = 0
Julia
O módulo julia exibe a versão atual instalada do Julia. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
Project.toml - O diretório atual contem um arquivo
Manifest.toml - O diretório atual contem arquivos com a extensão
.jl
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
detect_extensions |
["jl"] |
Quais extensões devem ativar este módulo. |
detect_files |
["Project.toml", "Manifest.toml"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
symbol |
"ஃ " |
O formato de string que representa o simbolo do Julia. |
style |
"bold purple" |
O estilo do módulo. |
disabled |
false |
Desabilita o módulo julia. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.4.0 |
A versão do julia |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[julia]
symbol = "∴ "
Kotlin
O módulo kotlin exibie a versão atual instalada do Kotlin. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
.ktou um arquivo.kts
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
detect_extensions |
["kt", "kts"] |
Quais extensões devem ativar este módulo. |
detect_files |
[] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
symbol |
"🅺 " |
O formato de string que representa o simbolo do Kotlin. |
style |
"bold blue" |
O estilo do módulo. |
kotlin_binary |
"kotlin" |
Configura o binário do kotlin que o Starship executa para obter a versão. |
disabled |
false |
Desabilita o módulo kotlin. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.4.21 |
A versão do kotlin |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml
[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"
Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.
::: tip
Este módulo é desativado por padrão. Para ativa-lo, defina disabled para false no seu arquivo de configuração.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
symbol |
"☸ " |
A format string representing the symbol displayed before the Cluster. |
format |
'[$symbol$context( \($namespace\))]($style) in ' |
O formato do módulo. |
style |
"cyan bold" |
O estilo do módulo. |
context_aliases |
Tabela de aliases de contexto para exibir. | |
disabled |
true |
Desabilita o módulo kubernetes. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| context | starship-cluster |
O contexto atual do kubernetes |
| namespace | starship-namespace |
Se definido o namespace atual do kubernetes |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"
Regex Matching
Additional to simple aliasing, context_aliases also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using $name and $N in the replacement. This is more explained in the regex crate documentation.
Long and automatically generated cluster names can be identified and shortened using regular expressions:
[kubernetes.context_aliases]
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
".*/openshift-cluster/.*" = "openshift"
# Or better, to rename every OpenShift cluster at once:
".*/(?P<cluster>[\\w-]+)/.*" = "$cluster"
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"
Quebra de linha
O módulo line_break separa o prompt em duas linhas.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
disabled |
false |
Desabilita o módulo line_break, fazendo com que o prompt seja em uma unica linha. |
Exemplo
# ~/.config/starship.toml
[line_break]
disabled = true
Lua
The lua module shows the currently installed version of Lua. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a
.lua-versionfile - The current directory contains a
luadirectory - The current directory contains a file with the
.luaextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🌙 " |
A format string representing the symbol of Lua. |
detect_extensions |
["lua"] |
Quais extensões devem ativar este módulo. |
detect_files |
[".lua-version"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
["lua"] |
Quais pastas devem ativar este módulo. |
style |
"bold blue" |
O estilo do módulo. |
lua_binary |
"lua" |
Configures the lua binary that Starship executes when getting the version. |
disabled |
false |
Disables the lua module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v5.4.0 |
The version of lua |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
Uso de memória
The memory_usage module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip
Este módulo é desativado por padrão. Para ativa-lo, defina disabled para false no seu arquivo de configuração.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
threshold |
75 |
Hide the memory usage unless it exceeds this percentage. |
format |
"via $symbol [${ram}( | ${swap})]($style) " |
O formato do módulo. |
symbol |
"🐏" |
The symbol used before displaying the memory usage. |
style |
"bold dimmed white" |
O estilo do módulo. |
disabled |
true |
Disables the memory_usage module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| ram | 31GiB/65GiB |
The usage/total RAM of the current system memory. |
| ram_pct | 48% |
The percentage of the current system memory. |
| swap** | 1GiB/4GiB |
The swap memory size of the current system swap memory file. |
| swap_pct** | 77% |
The swap memory percentage of the current system swap memory file. |
| symbol | 🐏 |
Espelha o valor da opção symbol |
| style* | Espelha o valor da opção style |
*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system
Exemplo
# ~/.config/starship.toml
[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"
Mercurial Branch
The hg_branch module shows the active branch of the repo in your current directory.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
symbol |
" " |
The symbol used before the hg bookmark or branch name of the repo in your current directory. |
style |
"bold purple" |
O estilo do módulo. |
format |
"on [$symbol$branch]($style) " |
O formato do módulo. |
truncation_length |
2^63 - 1 |
Truncates the hg branch name to N graphemes |
truncation_symbol |
"…" |
O simbolo usado para indicar que o nome braço foi truncado. |
disabled |
true |
Disables the hg_branch module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| branch | master |
The active mercurial branch |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""
Nim
The nim module shows the currently installed version of Nim. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
nim.cfg - The current directory contains a file with the
.nimextension - The current directory contains a file with the
.nimsextension - The current directory contains a file with the
.nimbleextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"👑 " |
The symbol used before displaying the version of Nim. |
detect_extensions |
["nim", "nims", "nimble"] |
Quais extensões devem ativar este módulo. |
detect_files |
["nim.cfg"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"bold yellow" |
O estilo do módulo. |
disabled |
false |
Disables the nim module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.2.0 |
The version of nimc |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
Nix-shell
The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
'via [$symbol$state( \($name\))]($style) ' |
O formato do módulo. |
symbol |
"❄️ " |
A format string representing the symbol of nix-shell. |
style |
"bold blue" |
O estilo do módulo. |
impure_msg |
"impure" |
A format string shown when the shell is impure. |
pure_msg |
"pure" |
A format string shown when the shell is pure. |
disabled |
false |
Disables the nix_shell module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| state | pure |
The state of the nix-shell |
| name | lorri |
The name of the nix-shell |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[nix_shell]
disabled = true
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = 'via [☃️ $state( \($name\))](bold blue) '
Node.js
The nodejs module shows the currently installed version of Node.js. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem o arquivo
package.json - The current directory contains a
.node-versionfile - The current directory contains a
.nvmrcfile - The current directory contains a
node_modulesdirectory - The current directory contains a file with the
.js,.mjsor.cjsextension - The current directory contains a file with the
.tsextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
" " |
A format string representing the symbol of Node.js. |
detect_extensions |
["js", "mjs", "cjs", "ts"] |
Quais extensões devem ativar este módulo. |
detect_files |
["package.json", ".node-version"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
["node_modules"] |
Quais pastas devem ativar este módulo. |
style |
"bold green" |
O estilo do módulo. |
disabled |
false |
Disables the nodejs module. |
not_capable_style |
bold red |
The style for the module when an engines property in package.json does not match the Node.js version. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v13.12.0 |
The version of node |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[nodejs]
format = "via [🤖 $version](bold green) "
OCaml
The ocaml module shows the currently installed version of OCaml. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a file with
.opamextension or_opamdirectory - The current directory contains a
esy.lockdirectory - The current directory contains a
duneordune-projectfile - The current directory contains a
jbuildorjbuild-ignorefile - The current directory contains a
.merlinfile - The current directory contains a file with
.ml,.mli,.reor.reiextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)" |
The format string for the module. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🐫 " |
The symbol used before displaying the version of OCaml. |
global_switch_indicator |
"" |
The format string used to represent global OPAM switch. |
local_switch_indicator |
"*" |
The format string used to represent local OPAM switch. |
detect_extensions |
["opam", "ml", "mli", "re", "rei"] |
Quais extensões devem ativar este módulo. |
detect_files |
["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
["_opam", "esy.lock"] |
Quais pastas devem ativar este módulo. |
style |
"bold yellow" |
O estilo do módulo. |
disabled |
false |
Disables the ocaml module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v4.10.0 |
The version of ocaml |
| switch_name | my-project |
The active OPAM switch |
| switch_indicator | Mirrors the value of indicator for currently active OPAM switch |
|
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
OpenStack
The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations. to fetch the current project in use.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"on [$symbol$cloud(\\($project\\))]($style) " |
O formato do módulo. |
symbol |
"☁️ " |
The symbol used before displaying the current OpenStack cloud. |
style |
"bold yellow" |
O estilo do módulo. |
disabled |
false |
Disables the openstack module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| cloud | corp |
The current OpenStack cloud |
| project | dev |
The current OpenStack project |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
Package Version
The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm, nimble, cargo, poetry, composer, gradle, julia, mix, helm and shards packages.
- npm – The
npmpackage version is extracted from thepackage.jsonpresent in the current directory - Cargo – The
cargopackage version is extracted from theCargo.tomlpresent in the current directory - Nimble - The
nimblepackage version is extracted from the*.nimblefile present in the current directory with thenimble dumpcommand - Poetry – The
poetrypackage version is extracted from thepyproject.tomlpresent in the current directory - Python - The
pythonpackage version is extracted from thesetup.cfgpresent in the current directory - Composer – The
composerpackage version is extracted from thecomposer.jsonpresent in the current directory - Gradle – The
gradlepackage version is extracted from thebuild.gradlepresent - Julia - The package version is extracted from the
Project.tomlpresent - Mix - The
mixpackage version is extracted from themix.exspresent - Helm - The
helmchart version is extracted from theChart.yamlpresent - Maven - The
mavenpackage version is extracted from thepom.xmlpresent - Meson - The
mesonpackage version is extracted from themeson.buildpresent - Shards - The
shardspackage version is extracted from theshard.ymlpresent - V - The
vlangpackage version is extracted from thev.modpresent
⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"is [$symbol$version]($style) " |
O formato do módulo. |
symbol |
"📦 " |
The symbol used before displaying the version the package. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
style |
"bold 208" |
O estilo do módulo. |
display_private |
false |
Enable displaying version for packages marked as private. |
disabled |
false |
Disables the package module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.0.0 |
The version of your package |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
Perl
The perl module shows the currently installed version of Perl. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a
Makefile.PLorBuild.PLfile - The current directory contains a
cpanfileorcpanfile.snapshotfile - The current directory contains a
META.jsonfile orMETA.ymlfile - The current directory contains a
.perl-versionfile - The current directory contains a
.pl,.pmor.pod
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
The format string for the module. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🐪 " |
The symbol used before displaying the version of Perl |
detect_extensions |
["pl", "pm", "pod"] |
Quais extensões devem ativar este módulo. |
detect_files |
["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"bold 149" |
O estilo do módulo. |
disabled |
false |
Disables the perl module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v5.26.1 |
The version of perl |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
Exemplo
# ~/.config/starship.toml
[perl]
format = "via [🦪 $version]($style) "
PHP
The php module shows the currently installed version of PHP. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo
composer.json - The current directory contains a
.php-versionfile - The current directory contains a
.phpextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🐘 " |
The symbol used before displaying the version of PHP. |
detect_extensions |
["php"] |
Quais extensões devem ativar este módulo. |
detect_files |
["composer.json", ".php-version"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"147 bold" |
O estilo do módulo. |
disabled |
false |
Disables the php module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v7.3.8 |
The version of php |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[php]
format = "via [🔹 $version](147 bold) "
Pulumi
The pulumi module shows the currently selected Pulumi Stack and version.
::: tip
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, follow the example shown below.
:::
Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains either
Pulumi.yamlorPulumi.yml - A parent directory contains either
Pulumi.yamlorPulumi.yml
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol$stack]($style) " |
The format string for the module. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
" " |
A format string shown before the Pulumi stack. |
style |
"bold 5" |
O estilo do módulo. |
disabled |
false |
Disables the pulumi module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v0.12.24 |
The version of pulumi |
| stack | dev |
The current Pulumi stack |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
With Pulumi Version
# ~/.config/starship.toml
[pulumi]
format = "[🛥 ($version )$stack]($style) "
Without Pulumi version
# ~/.config/starship.toml
[pulumi]
symbol = "🛥 "
format = "[$symbol$stack]($style) "
PureScript
The purescript module shows the currently installed version of PureScript version. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a
spago.dhallfile - The current directory contains a file with the
.pursextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"<=> " |
The symbol used before displaying the version of PureScript. |
detect_extensions |
["purs"] |
Quais extensões devem ativar este módulo. |
detect_files |
["spago.dhall"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"bold white" |
O estilo do módulo. |
disabled |
false |
Disables the purescript module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | 0.13.5 |
The version of purescript |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
Python
The python module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.
Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a
.python-versionfile - The current directory contains a
Pipfilefile - The current directory contains a
__init__.pyfile - The current directory contains a
pyproject.tomlfile - The current directory contains a
requirements.txtfile - The current directory contains a
setup.pyfile - The current directory contains a
tox.inifile - The current directory contains a file with the
.pyextension. - A virtual environment is currently activated
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)' |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🐍 " |
A format string representing the symbol of Python |
style |
"yellow bold" |
O estilo do módulo. |
pyenv_version_name |
false |
Use pyenv to get Python version |
pyenv_prefix |
pyenv |
Prefix before pyenv version display, only used if pyenv is used |
python_binary |
["python", "python3", "python2"] |
Configures the python binaries that Starship should executes when getting the version. |
detect_extensions |
["py"] |
Quais extensões devem acionar este módulo |
detect_files |
[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"] |
[] |
detect_folders |
[] |
Quais pastas devem ativar este módulo |
disabled |
false |
Disables the python module. |
::: tip
The python_binary variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.
The default values and order for python_binary was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python, no matter if it points to python3 or python2). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to "python3" will hide any Python version 2, see example below.
:::
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | "v3.8.1" |
The version of python |
| symbol | "🐍 " |
Espelha o valor da opção symbol |
| style | "yellow bold" |
Espelha o valor da opção style |
| pyenv_prefix | "pyenv " |
Mirrors the value of option pyenv_prefix |
| virtualenv | "venv" |
The current virtualenv name |
Exemplo
# ~/.config/starship.toml
[python]
symbol = "👾 "
pyenv_version_name = true
# ~/.config/starship.toml
[python]
# Only use the `python3` binary to get the version.
python_binary = "python3"
# ~/.config/starship.toml
[python]
# Don't trigger for files with the py extension
detect_extensions = []
# ~/.config/starship.toml
[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ["./venv/bin/python", "python", "python3", "python2"]
R
The rlang module shows the currently installed version of R. The module will be shown if any of the following conditions are met:
- The current directory contains a file with the
.Rextension. - The current directory contains a file with the
.Rdextension. - The current directory contains a file with the
.Rmdextension. - The current directory contains a file with the
.Rprojextension. - The current directory contains a file with the
.Rsxextension. - The current directory contains a
.Rprofilefile - The current directory contains a
.Rproj.userfolder
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"📐" |
A format string representing the symbol of R. |
style |
"blue bold" |
O estilo do módulo. |
detect_extensions |
["R", "Rd", "Rmd", "Rproj", "Rsx"] |
Quais extensões devem acionar este módulo |
detect_files |
[".Rprofile"] |
[] |
detect_folders |
[".Rproj.user"] |
Quais pastas devem ativar este módulo |
disabled |
false |
Disables the r module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v4.0.5 |
The version of R |
| symbol | Espelha o valor da opção symbol |
|
| style | "blue bold" |
Espelha o valor da opção style |
Exemplo
# ~/.config/starship.toml
[rlang]
format = "with [📐 $version](blue bold) "
Red
By default the red module shows the currently installed version of Red. The module will be shown if any of the following conditions are met:
- The current directory contains a file with
.redor.redsextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🔺 " |
A format string representing the symbol of Red. |
detect_extensions |
["red"] |
Quais extensões devem ativar este módulo. |
detect_files |
[] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"red bold" |
O estilo do módulo. |
disabled |
false |
Disables the red module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v2.5.1 |
The version of red |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[red]
symbol = "🔴 "
Ruby
By default the ruby module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a
Gemfilefile - The current directory contains a
.ruby-versionfile - The current directory contains a
.rbfile - The environment variables
RUBY_VERSIONorRBENV_VERSIONare set
Starship gets the current Ruby version by running ruby -v.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"💎 " |
A format string representing the symbol of Ruby. |
detect_extensions |
["rb"] |
Quais extensões devem ativar este módulo. |
detect_files |
["Gemfile", ".ruby-version"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
detect_variables |
["RUBY_VERSION", "RBENV_VERSION"] |
Which environment variables should trigger this module. |
style |
"bold red" |
O estilo do módulo. |
disabled |
false |
Disables the ruby module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v2.5.1 |
The version of ruby |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
Rust
By default the rust module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a
Cargo.tomlfile - The current directory contains a file with the
.rsextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🦀 " |
A format string representing the symbol of Rust |
detect_extensions |
["rs"] |
Quais extensões devem ativar este módulo. |
detect_files |
["Cargo.toml"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"bold red" |
O estilo do módulo. |
disabled |
false |
Disables the rust module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v1.43.0-nightly |
The version of rustc |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[rust]
format = "via [⚙️ $version](red bold)"
Scala
The scala module shows the currently installed version of Scala. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a
build.sbt,.scalaenvor.sbtenvfile - The current directory contains a file with the
.scalaor.sbtextension - The current directory contains a directory named
.metals
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [${symbol}(${version} )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
detect_extensions |
["sbt", "scala"] |
Quais extensões devem ativar este módulo. |
detect_files |
[".scalaenv", ".sbtenv", "build.sbt"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[".metals"] |
Quais pastas devem ativar este módulo. |
symbol |
"🆂 " |
A format string representing the symbol of Scala. |
style |
"red dimmed" |
O estilo do módulo. |
disabled |
false |
Disables the scala module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | 2.13.5 |
The version of scala |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[scala]
symbol = "🌟 "
Shell
The shell module shows an indicator for currently used shell.
::: tip
Este módulo é desativado por padrão. Para ativa-lo, defina disabled para false no seu arquivo de configuração.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
bash_indicator |
bsh |
A format string used to represent bash. |
fish_indicator |
fsh |
A format string used to represent fish. |
zsh_indicator |
zsh |
A format string used to represent zsh. |
powershell_indicator |
psh |
A format string used to represent powershell. |
ion_indicator |
ion |
A format string used to represent ion. |
elvish_indicator |
esh |
A format string used to represent elvish. |
tcsh_indicator |
tsh |
A format string used to represent tcsh. |
xonsh_indicator |
xsh |
A format string used to represent xonsh. |
unknown_indicator |
The default value to be displayed when the shell is unknown. | |
format |
"[$indicator]($style) " |
O formato do módulo. |
style |
"white bold" |
O estilo do módulo. |
disabled |
true |
Disables the shell module. |
Variáveis
| Variável | Padrão | Descrição |
|---|---|---|
| indicator | Mirrors the value of indicator for currently used shell. |
|
| style* | Mirrors the value of option style. |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplos
# ~/.config/starship.toml
[shell]
fish_indicator = ""
powershell_indicator = "_"
unknown_indicator = "mystery shell"
style = "cyan bold"
disabled = false
SHLVL
The shlvl module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
threshold |
2 |
Display threshold. |
format |
"[$symbol$shlvl]($style) " |
O formato do módulo. |
symbol |
"↕️ " |
The symbol used to represent the SHLVL. |
repeat |
false |
Causes symbol to be repeated by the current SHLVL amount. |
style |
"bold yellow" |
O estilo do módulo. |
disabled |
true |
Disables the shlvl module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| shlvl | 3 |
The current value of SHLVL |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
Singularidade
The singularity module shows the current Singularity image, if inside a container and $SINGULARITY_NAME is set.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
'[$symbol\[$env\]]($style) ' |
O formato do módulo. |
symbol |
"" |
A format string displayed before the image name. |
style |
"bold dimmed blue" |
O estilo do módulo. |
disabled |
false |
Disables the singularity module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| env | centos.img |
The current Singularity image |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[singularity]
format = '[📦 \[$env\]]($style) '
Status
The status module displays the exit code of the previous command. The module will be shown only if the exit code is not 0.
::: tip
Este módulo é desativado por padrão. Para ativa-lo, defina disabled para false no seu arquivo de configuração.
:::
::: warning This module is not supported on elvish and nu shell. :::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"[$symbol$status]($style) " |
The format of the module |
symbol |
"✖" |
The symbol displayed on program error |
success_symbol |
"✔️" |
The symbol displayed on program success |
not_executable_symbol |
"🚫" |
The symbol displayed when file isn't executable |
not_found_symbol |
"🔍" |
The symbol displayed when the command can't be found |
sigint_symbol |
"🧱" |
The symbol displayed on SIGINT (Ctrl + c) |
signal_symbol |
"⚡" |
The symbol displayed on any signal |
style |
"bold red" |
O estilo do módulo. |
recognize_signal_code |
true |
Enable signal mapping from exit code |
map_symbol |
false |
Enable symbols mapping from exit code |
pipestatus |
false |
Enable pipestatus reporting |
pipestatus_separator |
` | ` |
pipestatus_format |
\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) |
The format of the module when the command is a pipeline |
disabled |
true |
Disables the status module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| status | 127 |
The exit code of the last command |
| int | 127 |
The exit code of the last command |
| common_meaning | ERROR |
Meaning of the code if not a signal |
| signal_number | 9 |
Signal number corresponding to the exit code, only if signalled |
| signal_name | KILL |
Name of the signal corresponding to the exit code, only if signalled |
| maybe_int | 7 |
Contains the exit code number when no meaning has been found |
| pipestatus | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false
Swift
By default the swift module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a
Package.swiftfile - The current directory contains a file with the
.swiftextension
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"🐦 " |
A format string representing the symbol of Swift |
detect_extensions |
["swift"] |
Quais extensões devem ativar este módulo. |
detect_files |
["Package.swift"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"bold 202" |
O estilo do módulo. |
disabled |
false |
Disables the swift module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v5.2.4 |
The version of swift |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
Terraform
The terraform module shows the currently selected Terraform workspace and version.
::: tip
By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below.
:::
Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a
.terraformfolder - Current directory contains a file with the
.tf,.tfplanor.tfstateextensions
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol$workspace]($style) " |
The format string for the module. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"💠" |
A format string shown before the terraform workspace. |
detect_extensions |
["tf", "tfplan", "tfstate"] |
Quais extensões devem ativar este módulo. |
detect_files |
[] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[".terraform"] |
Quais pastas devem ativar este módulo. |
style |
"bold 105" |
O estilo do módulo. |
disabled |
false |
Disables the terraform module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v0.12.24 |
The version of terraform |
| workspace | default |
The current Terraform workspace |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
With Terraform Version
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $version$workspace]($style) "
Without Terraform version
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
Horário
The time module shows the current local time. The format configuration value is used by the chrono crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.
::: tip
Este módulo é desativado por padrão. Para ativa-lo, defina disabled para false no seu arquivo de configuração.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"at [$time]($style) " |
The format string for the module. |
use_12hr |
false |
Enables 12 hour formatting |
time_format |
see below | The chrono format string used to format the time. |
style |
"bold yellow" |
The style for the module time |
utc_time_offset |
"local" |
Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
disabled |
true |
Disables the time module. |
time_range |
"-" |
Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If use_12hr is true, then time_format defaults to "%r". Otherwise, it defaults to "%T". Manually setting time_format will override the use_12hr setting.
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| time | 13:08:10 |
The current time. |
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
Username
The username module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root
- The current user isn't the same as the one that is logged in
- The user is currently connected as an SSH session
- The variable
show_alwaysis set to true
::: tip
SSH connection is detected by checking environment variables SSH_CONNECTION, SSH_CLIENT, and SSH_TTY. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
style_root |
"bold red" |
The style used when the user is root. |
style_user |
"bold yellow" |
The style used for non-root users. |
format |
"[$user]($style) in " |
O formato do módulo. |
show_always |
false |
Always shows the username module. |
disabled |
false |
Disables the username module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
style |
"red bold" |
Mirrors the value of option style_root when root is logged in and style_user otherwise. |
user |
"matchai" |
The currently logged-in user ID. |
Exemplo
# ~/.config/starship.toml
[username]
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true
Vagrant
The vagrant module shows the currently installed version of Vagrant. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a
Vagrantfilefile
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"⍱ " |
A format string representing the symbol of Vagrant. |
detect_extensions |
[] |
Quais extensões devem ativar este módulo. |
detect_files |
["Vagrantfile"] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"cyan bold" |
O estilo do módulo. |
disabled |
false |
Disables the vagrant module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | Vagrant 2.2.10 |
The version of Vagrant |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[vagrant]
format = "via [⍱ $version](bold white) "
V
The vlang module shows you your currently installed version of V. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a file with
.vextension - The current directory contains a
v.mod,vpkg.jsonor.vpkg-lock.jsonfile
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"V " |
A format string representing the symbol of V |
detect_extensions |
["v"] |
Quais extensões devem ativar este módulo. |
detect_files |
["v.mod", "vpkg.json", ".vpkg-lock.json" ] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
style |
"blue bold" |
O estilo do módulo. |
disabled |
false |
Disables the vlang module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v0.2 |
The version of v |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
Exemplo
# ~/.config/starship.toml
[vlang]
format = "via [V $version](blue bold) "
VCSH
The vcsh module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.
Opções
| Opções | Padrão | Descrição |
|---|---|---|
symbol |
The symbol used before displaying the repository name. | |
style |
"bold yellow" |
O estilo do módulo. |
format |
"vcsh [$symbol$repo]($style) " |
O formato do módulo. |
disabled |
false |
Disables the vcsh module. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| repo | dotfiles if in a VCSH repo named dotfiles |
The active repository name |
| symbol | Espelha o valor da opção symbol |
|
| style* | black bold dimmed |
Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[vcsh]
format = "[🆅 $repo](bold blue) "
Zig
By default the the zig module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
- The current directory contains a
.zigfile
Opções
| Opções | Padrão | Descrição |
|---|---|---|
format |
"via [$symbol($version )]($style)" |
O formato do módulo. |
version_format |
"v${raw}" |
O formato da versão. As variáveis disponíveis são raw, major, minor, & patch |
symbol |
"↯ " |
The symbol used before displaying the version of Zig. |
style |
"bold yellow" |
O estilo do módulo. |
disabled |
false |
Disables the zig module. |
detect_extensions |
["zig"] |
Quais extensões devem ativar este módulo. |
detect_files |
[] |
Quais nomes de arquivos devem ativar este módulo. |
detect_folders |
[] |
Quais pastas devem ativar este módulo. |
Variáveis
| Variável | Exemplo | Descrição |
|---|---|---|
| version | v0.6.0 |
The version of zig |
| symbol | Espelha o valor da opção symbol |
|
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Exemplo
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
Custom commands
The custom modules show the output of some arbitrary commands.
These modules will be shown if any of the following conditions are met:
- The current directory contains a file whose name is in
files - The current directory contains a directory whose name is in
directories - The current directory contains a file whose extension is in
extensions - The
whencommand returns 0 - The current Operating System (std::env::consts::OS) matchs with
osfield if defined.
::: tip
Multiple custom modules can be defined by using a ..
:::
::: tip
The order in which custom modules are shown can be individually set by including ${custom.foo} in the top level format (as it includes a dot, you need to use ${...}). By default, the custom module will simply show all custom modules in the order they were defined.
:::
::: tip
Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
:::
::: warning Command output is printed unescaped to the prompt
Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. \h, but this module will not work in a fish or zsh shell.
Format strings can also contain shell specific prompt sequences, e.g. Bash, Zsh.
:::
Opções
| Opções | Padrão | Descrição |
|---|---|---|
command |
"" |
The command whose output should be printed. The command will be passed on stdin to the shell. |
when |
A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code. |
|
shell |
See below | |
description |
"<custom module>" |
The description of the module that is shown when running starship explain. |
files |
[] |
The files that will be searched in the working directory for a match. |
directories |
[] |
The directories that will be searched in the working directory for a match. |
extensions |
[] |
The extensions that will be searched in the working directory for a match. |
symbol |
"" |
The symbol used before displaying the command output. |
style |
"bold green" |
O estilo do módulo. |
format |
"[$symbol($output )]($style)" |
O formato do módulo. |
disabled |
false |
Disables this custom module. |
os |
Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values. |
Variáveis
| Variável | Descrição |
|---|---|
| output | The output of shell command in shell |
| symbol | Espelha o valor da opção symbol |
| style* | Espelha o valor da opção style |
*: Essa variável só pode ser usada como parte de uma string de estilo
Custom command shell
shell accepts a non-empty list of strings, where:
- The first string is the path to the shell to use to execute the command.
- Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
The command will be passed in on stdin.
If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
shell = ["pwsh", "-Command", "-"]
::: warning Make sure your custom shell configuration exits gracefully
If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell option).
For example, PowerShell requires the -Command parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.
Parameters similar to -NoProfile in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.
Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.
:::
Exemplo
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters but wildcards are not supported
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"
[custom.time]
command = "time /T"
extensions = ["pst"] # filters *.pst files
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]