# Configuração Para começar a configurar a starship, crie o seguinte arquivo: `~/.config/starship.toml`. ```sh mkdir -p ~/.config && touch ~/.config/starship.toml ``` Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml): ```toml # Get editor completions based on the config schema "$schema" = 'https://starship.rs/config-schema.json' # Inserts a blank line between shell prompts add_newline = true # Replace the '❯' symbol in the prompt with '➜' [character] # The name of the module we are configuring is 'character' success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green' # Disable the package module, hiding it from the prompt completely [package] disabled = true ``` ### Config File Location Você pode alterar o caminho padrão do arquivo de configuração com a variável de ambiente `STARSHIP_CONFIG`: ```sh export STARSHIP_CONFIG=~/example/non/default/path/starship.toml ``` No PowerShell (Windows) você pode adicionar a seguinte linha no seu `$PROFILE`: ```powershell $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" ``` Ou para Cmd (Windows) seria adicionar esta linha no seu `starship.lua`: ```lua os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.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`: ```sh export STARSHIP_CACHE=~/.starship/cache ``` No PowerShell (Windows) você pode adicionar a seguinte linha no seu `$PROFILE`: ```powershell $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ``` Ou para Cmd (Windows) seria adicionar esta linha no seu `starship.lua`: ```lua os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\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. ### Strings In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`. The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. | Symbol | Type | Notes | | ------ | ------------------------- | ------------------------------------------------------ | | `'` | literal string | less escaping | | `"` | string | more escaping | | `'''` | multi-line literal string | less escaping | | `"""` | multi-line string | more escaping, newlines in declarations can be ignored | Por exemplo: ```toml # literal string format = '☺\☻ ' # regular string format = "☺\\☻ " # escaping Starship symbols format = '\[\$\] ' ``` When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent: ```toml # with literal string format = ''' \$''' # with multiline basic string format = """ \\$""" # with basic string format = "\n\\$" ``` In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them. ```toml format = """ line1\ line1\ line1 line2\ line2\ line2 """ ``` ### Formatação de Strings As strings de formato são o formato com o qual um módulo imprime todas as suas variáveis. A maioria dos módulos tem uma entrada chamada `format` que configura o formato de exibição do módulo. Você pode usar textos, variáveis e grupos de texto em uma string de formato. #### Variável Uma variável contém um símbolo `$` seguido pelo nome da variável. O nome de uma variável pode conter apenas letras, números e `_`. Por exemplo: - `'$version'` is a format string with a variable named `version`. - `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`. - `'$git_branch $git_commit'` has the two variables separated with a space. #### Grupo de Texto Um grupo de texto é composto de duas partes diferentes. A primeira parte, que está entre um `[]`, é uma [string de formato](#format-strings). Você pode adicionar textos, variáveis ou até mesmo grupos de texto aninhados nele. Na segunda parte, que está dentro de um `()`, está uma [string de estilo](#style-strings). Isso pode ser usado para estilizar a primeira parte. Por exemplo: - `'[on](red bold)'` will print a string `on` with bold text colored red. - `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green. #### Estilo dos textos A maioria dos módulos no starship permite que você configure seus estilos de exibição. Isso é feito com uma entrada (normalmente chamada de `estilo`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo junto com o que elas fazem. Para obter detalhes sobre a sintaxe completa, consulte o [guia de configuração avançada](/advanced-config/). - `'fg:green bg:blue'` sets green text on a blue background - `'bg:blue fg:bright-green'` sets bright green text on a blue background - `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27 - `'underline bg:#bf5700'` sets underlined text on a burnt orange background - `'bold italic fg:purple'` sets bold italic purple text - `''` explicitly disables all styling Observe que a aparência do estilo será controlada pelo emulador de terminal. Por exemplo, alguns emuladores de terminal irão clarear as cores em vez de colocar o texto em negrito, e alguns temas de cores usam os mesmos valores para as cores normais e brilhantes. Além disso, para obter texto em itálico, seu terminal deve suportar itálico. #### Formatação de String Condicional Uma string de formato condicional envolta de `(` e `)` não será renderizada se todas as variáveis internas estiverem vazias. Por exemplo: - `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region. - `'(some text)'` will always show nothing since there are no variables wrapped in the braces. - When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`. ### Negative matching Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of _any_ negative indicator in the directory will result in the module not being matched. Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all. To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus: ```toml detect_extensions = ['ts', '!video.ts', '!audio.ts'] ``` ## Prompt de Comando Esta é a lista de opções de configuração em todo o prompt. ### Opções | Opções | Padrão | Descrição | | ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `format` | [link](#default-prompt-format) | Configura o formato do prompt. | | `right_format` | `''` | Veja [Ativa o prompt direito](/advanced-config/#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. | | `palette` | `''` | Sets which color palette from `palettes` to use. | | `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. | ### Exemplo ```toml # ~/.config/starship.toml # Use custom format format = ''' [┌───────────────────>](bold green) [│](bold green)$directory$rust$package [└─>](bold green) ''' # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 # Disable the blank line at the start of the prompt add_newline = false # Set 'foo' as custom color palette palette = 'foo' # Define custom colors [palettes.foo] # Overwrite existing color blue = '21' # Define new color mustard = '#af8700' ``` ### Format de Prompt Padrão O padrão `format` é usado para definir o formato do prompt, se estiver vazio ou nenhum `format` for fornecido. O padrão é como mostrado: ```toml format = '$all' # Which is equivalent to format = """ $username\ $hostname\ $localip\ $shlvl\ $singularity\ $kubernetes\ $directory\ $vcsh\ $fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ $pijul_channel\ $docker_context\ $package\ $c\ $cmake\ $cobol\ $daml\ $dart\ $deno\ $dotnet\ $elixir\ $elm\ $erlang\ $fennel\ $golang\ $guix_shell\ $haskell\ $haxe\ $helm\ $java\ $julia\ $kotlin\ $gradle\ $lua\ $nim\ $nodejs\ $ocaml\ $opa\ $perl\ $php\ $pulumi\ $purescript\ $python\ $raku\ $rlang\ $red\ $ruby\ $rust\ $scala\ $swift\ $terraform\ $vlang\ $vagrant\ $zig\ $buf\ $nix_shell\ $conda\ $meson\ $spack\ $memory_usage\ $aws\ $gcloud\ $openstack\ $azure\ $env_var\ $crystal\ $custom\ $sudo\ $cmd_duration\ $line_break\ $jobs\ $battery\ $time\ $status\ $os\ $container\ $shell\ $character""" ``` Se você quiser apenas estender o formato padrão, você pode usar `$all`; os módulos que você adicionar explicitamente ao formato não serão duplicados. Ex. ```toml # Move the directory to the second line format = '$all$directory$character' ``` ## AWS The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. Quando usar [aws-vault](https://github.com/99designs/aws-vault), o perfil é lido da variável de ambiente `AWS_VAULT` e o tempo de expiração de credenciais é lido da variável de ambiente `AWS_SESSION_EXPIRATION`. Quando usar [awsu](https://github.com/kreuzwerker/awsu) o perfil é lido da varável de env `AWSU_PROFILE`. Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROFILE` e o tempo de expiração de credenciais é lida da variável de env `AWSUME_EXPIRATION`. When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key. ### 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. | | `profile_aliases` | `{}` | Tabela de apelidos de perfil a serem exibidos 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 módulo `AWS`. | | `force_display` | `false` | Se `true` exibe as informações mesmo que `credentials`, `credential_process` ou `sso_start_url` não tenham sido configurados. | ### 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 `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplos #### Exibir tudo ```toml # ~/.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' [aws.profile_aliases] CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Exibir região ```toml # ~/.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 ```toml # ~/.config/starship.toml [aws] format = 'on [$symbol$profile]($style) ' style = 'bold blue' symbol = '🅰 ' [aws.profile_aliases] Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure O módulo `azure` exibe a assinatura Azure atual. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. ### Opções | Variável | Padrão | Descrição | | ---------- | ---------------------------------------- | ---------------------------------------------- | | `format` | `'on [$symbol($subscription)]($style) '` | O formato que o módulo Azure será renderizado. | | `symbol` | `'ﴃ '` | O símbolo usado no formato. | | `style` | `'blue bold'` | O estilo usado no formato. | | `disabled` | `true` | Desabilita o módulo `azure`. | ### Exemplos #### Display Subscription Name ```toml # ~/.config/starship.toml [azure] disabled = false format = 'on [$symbol($subscription)]($style) ' symbol = 'ﴃ ' style = 'blue bold' ``` #### Display Username ```toml # ~/.config/starship.toml [azure] disabled = false format = "em [$symbol($username)]($style) " symbol = "ﴃ " style = "blue bold" ``` ## 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](#battery-display) | Limite de exibição e estilo para o módulo. | | `disabled` | `false` | Desabilita o módulo `battery`. | ### Exemplo ```toml # ~/.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. O padrão é como mostrado: ```toml [[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` | `'red bold'` | 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 ```toml [[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 ``` ## Buf O módulo `buf` mostra a versão instalada do [Buf](https://buf.build). Por padrão, o módulo é mostrado se todas as seguintes condições forem atendidas: - A CLI [`buf`](https://github.com/bufbuild/buf) está instalada. - O atual diretório contém um [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml) ou arquivo de configuração [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml). ### Opções | Opções | Padrão | Descrição | | ------------------- | ----------------------------------------------- | ------------------------------------------------- | | `format` | `'with [$symbol($version )]($style)'` | O formato do módulo `buf`. | | `version_format` | `'v${raw}'` | A versão formatada. | | `symbol` | `'🐃 '` | O símbolo usado antes de exibir a versão do Buf. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | 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 `elixir`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | | `version` | `v1.0.0` | A versão do `buf` | | `symbol` | | Espelha o valor da opção `symbol` | | `style`* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [buf] symbol = '🦬 ' ``` ## Bun The `bun` module shows the currently installed version of the [bun](https://bun.sh) JavaScript runtime. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `bun.lockb` - O diretório atual conter um arquivo `bunfig.toml` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🍞 '` | A format string representing the symbol of Bun. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_files` | `['bun.lockb', 'bunfig.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 `bun` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | | version | `v0.1.4` | The version of `bun` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [bun] format = 'via [🍔 $version](bold green) ' ``` ## C O módulo `c` mostra algumas informações sobre o seu compilador de C. Por padrão o módulo será exibido se o diretório atual contém um arquivo `.c` ou `.h`. ### Opções | Opções | Padrão | Descrição | | ------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version(-$name) )]($style)'` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'C '` | O símbolo utilizado antes de exibir os detalhes do compilador | | `detect_extensions` | `['c', 'h']` | 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. | | `commands` | [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] | Como detectar qual é o compilador | | `style` | `'bold 149'` | O estilo do módulo. | | `disabled` | `false` | Desabilita o módulo `c`. | ### Variáveis | Variável | Exemplo | Descrição | | -------- | ------- | --------------------------------- | | name | clang | O nome do compilador | | version | 13.0.0 | A versão do compilador | | symbol | | Espelha o valor da opção `symbol` | | style | | Espelha o valor da opção `style` | Note que `version` não está no formato padrão. ### Comandos A opção `commands` aceita uma lista de comandos para determinar a versão e o nome do compilador. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship tentará executar cada comando até que obtenha um resultado no STDOUT. Se um compilador C não é suportado por este módulo, você pode solicitá-lo [criando uma issue no GitHub](https://github.com/starship/starship/). ### Exemplo ```toml # ~/.config/starship.toml [c] format = 'via [$name $version]($style)' ``` ## 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](#with-custom-error-shape). ::: warning `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ::: ### 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. | | `vimcmd_symbol` | `'[❮](bold green)'` | O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. | | `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. | | `disabled` | `false` | Desabilita o módulo `character`. | ### Variáveis | Variável | Exemplo | Descrição | | -------- | ------- | -------------------------------------------------------------------------------------------------------- | | symbol | | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. | ### Exemplos #### Com formas customizadas de erro ```toml # ~/.config/starship.toml [character] success_symbol = '[➜](bold green) ' error_symbol = '[✗](bold red) ' ``` #### Sem formas customizadas de erro ```toml # ~/.config/starship.toml [character] success_symbol = '[➜](bold green) ' error_symbol = '[➜](bold red) ' ``` #### Com formas customizadas no vim ```toml # ~/.config/starship.toml [character] vicmd_symbol = '[V](bold green) ' ``` ## CMake O módulo `cmake` exibe a versão instalada do [CMake](https://cmake.org/). 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ## COBOL / GNUCOBOL O módulo `cobol` exibe a versão instalada atual do COBOL. Por padrão, o módulo será exibido se qualquer das seguintes condições for atendida: - O diretório atual tem qualquer arquivo com extensão `.cob` or `.COB` - O diretório atual tenham qualquer arquivo com extensão `.cbl` or `.CBL` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `symbol` | `'⚙️ '` | O simbolo usado antes de exibir a versão do COBOL. | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | Desabilita o módulo `cobol`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | | version | `v3.1.2.0` | A versão do `cobol` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta 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](https://github.com/rcaloras/bash-preexec). 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). | | `notification_timeout` | | Duração para mostrar a notificação (em milissegundos). Se não estiver definido, o tempo limite de notificação será determinado pelo daemon. Nem todos os daemons de notificação aceitam essa opção. | ### 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [cmd_duration] min_time = 500 format = 'underwent [$duration](bold yellow)' ``` ## Conda O módulo `conda` exibe o ambiente atual do [Conda](https://docs.conda.io/en/latest/), se o `$CONDA_DEFAULT_ENV` estiver definido. ::: 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`](#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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [conda] format = '[$symbol$environment](dimmed green) ' ``` ## Container O módulo `container` exibe um símbolo e nome do contêiner, se dentro de um container. ### Opções | Opções | Padrão | Descrição | | ---------- | ---------------------------------- | ------------------------------------------------- | | `symbol` | `'⬢'` | O símbolo mostrado, quando dentro de um contêiner | | `style` | `'bold red dimmed'` | O estilo do módulo. | | `format` | `'[$symbol \[$name\]]($style) '` | O formato do módulo. | | `disabled` | `false` | Desabilita o módulo `container`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------------- | --------------------------------- | | name | `fedora-toolbox:35` | O nome do contêiner | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [container] format = '[$symbol \[$name\]]($style) ' ``` ## Crystal O módulo `crystal` exibe a versão instalada atual do [Crystal](https://crystal-lang.org/). 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 símbolo usado antes de exibir a versão do crystal. | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [crystal] format = 'via [✨ $version](bold blue) ' ``` ## Daml The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `daml.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` | | `symbol` | `'Λ '` | A format string representing the symbol of Daml | | `style` | `'bold cyan'` | O estilo do módulo. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_files` | `['daml.yaml']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `disabled` | `false` | Disables the `daml` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | | version | `v2.2.0` | The version of `daml` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [daml] format = 'via [D $version](bold bright-green) ' ``` ## Dart O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). 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.yml` ou `pubspec.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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [dart] format = 'via [🔰 $version](bold red) ' ``` ## Deno O módulo `deno` exibe a versão instalada atual do [Deno](https://deno.land/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual tenha um arquivo `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.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` | `['deno.json', 'deno.jsonc', '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 ```toml # ~/.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. eg: '…/' | | `before_repo_root_style` | | The style for the path segment above the root of the git repo. O valor padrão é equivalente a `style`. | | `repo_root_style` | | O estilo para a raiz do repositório git. O valor padrão é equivalente a `style`. | | `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. | | `home_symbol` | `'~'` | O simbolo para indicar o diretório home. | | `use_os_path_sep` | `true` | Use o separador de caminho específico do sistema opracional em vez de sempre usar `/` (por exemplo, `\` no Windows) |
Este módulo tem algumas configurações avançadas que controlam como o diretório é exibido. | Opções Avançadas | Padrão | Descrição | | --------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substituições` | | Uma tabela de substituições para fazer no path. | | `fish_style_pwd_dir_length` | `0` | O número de caracteres para usar quando aplicado no path logico do fish shell pwd. | | `use_logical_path` | `true` | Se `true` exibe um caminho lógico originado do shell via `PWD` ou`--logical-path`. Se `false` em vez disso, exibe o caminho do filesystem com os symlinks resolvidos. | `substitutions` aceita você definir substituições arbitrarias para strings literais que ocorra no path, por exemplo prefixos de rede longos ou diretórios de desenvolvimento (ex:. Java). Note isto irá desabilita o estilo PWD do fish. ```toml [directory.substitutions] '/Volumes/network/path' = '/net' 'src/com/long/java/path' = 'mypath' ``` `fish_style_pwd_dir_length` interage com as opções de truncação padrão de uma forma que pode suprimir no começo: se não for zero, os componentes do path que normalmente seriam truncados são exibidos com todos caracteres. Por exemplo, o caminho `/built/this/city/on/rock/and/roll`, que normalmente seria exibido como`rock/and/roll`, seria exibido como `/b/t/c/o/rock/and/roll` com`fish_style_pwd_dir_length = 1`--os componentes de path que normalmente seriam removidos são exibidos com um único caractere. Para `fish_style_pwd_dir_length = 2`, seria `/bu/th/ci/on/rock/and/roll`.
### Variáveis | Variável | Exemplo | Descrição | | --------- | --------------------- | -------------------------------- | | path | `'D:/Projetos'` | O caminho do diretório atual | | style\* | `'black bold dimmed'` | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo
Os repositórios git têm variáveis adicionais. Vamos considerar o caminho `/caminho/para/home/git_repo/src/lib` | Variável | Exemplo | Descrição | | ------------------ | ----------------------- | --------------------------------------------------- | | before_root_path | `'/caminho/para/home/'` | O caminho antes do caminho do diretório raiz do git | | repo_root | `'git_repo'` | O nome do diretório raiz do git | | path | `'/src/lib'` | O caminho restante | | style | `'black bold dimmed'` | Espelha o valor da opção `style` | | repo_root_style | `'underline white'` | Estilo para o nome do diretório raiz do git |
### Exemplo ```toml # ~/.config/starship.toml [directory] truncation_length = 8 truncation_symbol = '…/' ``` ## Docker Context O módulo `docker_context` exibe o [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) ativo atualmente se não estiver definido como `default` ou se as variáveis de ambiente `DOCKER_MACHINE_NAME`, `DOCKER_HOST` ou `DOCKER_CONTEXT` estiverem definidas (iram sobrescrever o contexto atual). ### 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [docker_context] format = 'via [🐋 $context](blue bold)' ``` ## Dotnet O módulo `dotnet` exibe a versão relevante do [.NET Core SDK](https://dotnet.microsoft.com/) para o directório atual. Se o SDK foi predefinido no diretório atual, a versão será exibida. Caso contrário, o módulo exibe a versão mais recente instalada do SDK. Por padrão, este módulo só será exibido no seu prompt quando um ou mais dos seguintes arquivos estiverem presentes no diretório atual: - `global.json` - `project.json` - `Directory.Build.props` - `Directory.Build.targets` - `Packages.props` - `*.csproj` - `*.fsproj` - `*.xproj` Você também precisará do SDK do .NET Core instalado para usá-lo corretamente. Internamente, este módulo usa um mecanismo próprio para detecção da versão. Geralmente é duas vezes mais rápido que executar `dotnet --version`, mas pode exibir uma versão errada se o seu projeto .NET tiver o layout de diretórios incomum. Se precisão for mais importante que velocidade, você pode desabilitar o mecanismo definindo `heuristic = false` nas opções do módulo. O módulo também mostrará o Target Framework Moniker () quando houver um arquivo `.csproj` no diretório atual. ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )(🎯 $tfm )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'.NET '` | O símbolo usado na frente da versão do dotnet. | | `heuristic` | `true` | Usa a detecção de versão rápida para manter o starship ligeiro e hábil. | | `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 `dotnet` | | tfm | `netstandard2.0` | O Target Framework Moniker usado no projeto atual | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [dotnet] symbol = '🥅 ' style = 'green' heuristic = false ``` ## Elixir O módulo `elixir` exibe a versão instalada do [Elixir](https://elixir-lang.org/) e [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter 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}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'💧 '` | O símbolo usado na frente da versão do Elixir ou 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [elixir] symbol = '🔮 ' ``` ## Elm O módulo `elm` exibe a versão instalada do [Elm](https://elm-lang.org/). 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 atual contém arquivos `*.elm` ### Opções | Opções | Padrão | Descrição | | ------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [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 `variable` corresponde a uma variável existente - A configuração `variable` não está definida, mas a `default` está ::: tip The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. ::: ::: tip Múltiplas variáveis de ambiente 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 ```toml # ~/.config/starship.toml [env_var.USER] default = 'unknown user' ``` ::: ### Opções | Opções | Padrão | Descrição | | ------------- | ------------------------------ | ---------------------------------------------------------------------------- | | `symbol` | `""` | O símbolo usado antes de exibir o valor da variável. | | `variable` | | A variável de ambiente a ser exibida. | | `default` | | O valor padrão a ser exibido quando a variável selecionada não for definida. | | `format` | `"with [$env_value]($style) "` | O formato do módulo. | | `description` | `""` | The description of the module that is shown when running `starship explain`. | | `disabled` | `false` | Desabilita o módulo `env_var`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ----------------------------------------- | --------------------------------------- | | env_value | `Windows NT` (se a variável __ for `$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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [env_var] variable = 'SHELL' default = 'unknown shell' ``` Exibindo múltiplas variáveis de ambiente: ```toml # ~/.config/starship.toml [env_var.SHELL] variable = 'SHELL' default = 'unknown shell' [env_var.USER] default = 'unknown user' ``` ## Erlang O módulo `erlang` mostra a versão atualmente instalada do [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contém um arquivo `rebar.config`. - O diretório atual contém 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}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `' '` | O símbolo 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [erlang] format = 'via [e $version](bold red) ' ``` ## Fennel The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - The current directory contains a file with the `.fnl` extension ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | | `style` | `'bold green'` | O estilo do módulo. | | `detect_extensions` | `[fnl]` | 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 `fennel` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | | version | `v1.2.1` | The version of `fennel` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [fennel] symbol = '⫰ ' ``` ## Fill O módulo `fill` preenche qualquer espaço vazio da linha com um simbolo. Se múltiplos módulos `fill` estiverem presentes em uma linha, eles irão dividir o espaço entre eles. Isto é útil para alinhar outros módulos. ### Opções | Opções | Padrão | Descrição | | ---------- | -------------- | --------------------------------------- | | `symbol` | `'.'` | O simbolo usado para preencher a linha. | | `style` | `'bold black'` | O estilo do módulo. | | `disabled` | `false` | Desabilita o módulo `fill` | ### Exemplo ```toml # ~/.config/starship.toml format = 'AA $fill BB $fill CC' [fill] symbol = '-' style = 'bold green' ``` Produz um prompt parecido com: ``` AA -------------------------------------------- BB -------------------------------------------- CC ``` ## Fossil Branch The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. ### Opções | Opções | Padrão | Descrição | | ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | `format` | `'on [$symbol$branch]($style) '` | O formato do módulo. Use `'$branch'` to refer to the current branch name. | | `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | | `style` | `'bold purple'` | O estilo do módulo. | | `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `disabled` | `true` | Disables the `fossil_branch` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | | branch | `trunk` | The active Fossil branch | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [fossil_branch] symbol = '🦎 ' truncation_length = 4 truncation_symbol = '' ``` ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. ### Opções | Opções | Padrão | Descrição | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | O formato do módulo. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | | `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | | `style` | `'bold blue'` | O estilo do módulo. | | `disabled` | `false` | Disables the `gcloud` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------- | ------------------------------------------------------------------ | | region | `us-central1` | The current GCP region | | account | `foo` | The current GCP profile | | domain | `example.com` | The current GCP profile domain | | project | | The current GCP project | | active | `default` | The active config name written in `~/.config/gcloud/active_config` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplos #### Exibe conta e projeto ```toml # ~/.config/starship.toml [gcloud] format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' ``` #### Exibe apenas o nome da configuração ativa ```toml # ~/.config/starship.toml [gcloud] format = '[$symbol$active]($style) ' style = 'bold yellow' ``` #### Exibir conta e região ```toml # ~/.config/starship.toml [gcloud] symbol = '️🇬️ ' [gcloud.region_aliases] us-central1 = 'uc1' asia-northeast1 = 'an1' ``` #### Exibir conta e projeto apelidado ```toml # ~/.config/starship.toml [gcloud] format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' [gcloud.project_aliases] very-long-project-name = 'vlpn' ``` ## Git Branch The `git_branch` module shows the active branch of the repo in your current directory. ### Opções | Opções | Padrão | Descrição | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | O formato do módulo. Use `'$branch'` to refer to the current branch name. | | `symbol` | `' '` | A format string representing the symbol of git branch. | | `style` | `'bold purple'` | O estilo do módulo. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | | `disabled` | `false` | Disables the `git_branch` module. | ### Variáveis | Variável | Exemplo | Descrição | | ------------- | -------- | ------------------------------------------------------------------------------------------------------ | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | | remote_name | `origin` | The remote name. | | remote_branch | `master` | The name of the branch tracked on `remote_name`. | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [git_branch] symbol = '🌱 ' truncation_length = 4 truncation_symbol = '' ignore_branches = ['master', 'main'] ``` ## Git commit The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Opções | Opções | Padrão | Descrição | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | | `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | O formato do módulo. | | `style` | `'bold green'` | O estilo do módulo. | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | | `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | | `disabled` | `false` | Disables the `git_commit` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | -------------------------------------------- | | hash | `b703eb3` | The current git commit hash | | tag | `v1.0.0` | The tag name if showing tag info is enabled. | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [git_commit] commit_hash_length = 4 tag_symbol = '🔖 ' ``` ## Git State The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Opções | Opções | Padrão | Descrição | | -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | | `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | | `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | | `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | | `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | | `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `'bold yellow'` | O estilo do módulo. | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | O formato do módulo. | | `disabled` | `false` | Disables the `git_state` module. | ### Variáveis | Variável | Exemplo | Descrição | | ---------------- | ---------- | -------------------------------- | | state | `REBASING` | The current state of the repo | | progress_current | `1` | The current operation progress | | progress_total | `2` | The total operation progress | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [git_state] format = '[\($state( $progress_current of $progress_total)\)]($style) ' cherry_pick = '[🍒 PICKING](bold red)' ``` ## Git Metrics The `git_metrics` module will show the number of added and deleted lines in the current git repository. ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções | Opções | Padrão | Descrição | | -------------------- | ------------------------------------------------------------ | ------------------------------------- | | `added_style` | `'bold green'` | The style for the added count. | | `deleted_style` | `'bold red'` | The style for the deleted count. | | `only_nonzero_diffs` | `true` | Render status only for changed items. | | `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | O formato do módulo. | | `disabled` | `true` | Disables the `git_metrics` module. | ### Variáveis | Variável | Exemplo | Descrição | | ----------------- | ------- | ------------------------------------------- | | added | `1` | The current number of added lines | | deleted | `2` | The current number of deleted lines | | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [git_metrics] added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ``` ## Git Status The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. ::: ### Opções | Opções | Padrão | Descrição | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `conflicted` | `'='` | This branch has merge conflicts. | | `ahead` | `'⇡'` | The format of `ahead` | | `behind` | `'⇣'` | The format of `behind` | | `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | | `untracked` | `'?'` | The format of `untracked` | | `stashed` | `'$'` | The format of `stashed` | | `modified` | `'!'` | The format of `modified` | | `staged` | `'+'` | The format of `staged` | | `renamed` | `'»'` | The format of `renamed` | | `deleted` | `'✘'` | The format of `deleted` | | `style` | `'bold red'` | O estilo do módulo. | | `ignore_submodules` | `false` | Ignore changes to submodules. | | `disabled` | `false` | Disables the `git_status` module. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | ### Variáveis The following variables can be used in `format`: | Variável | Descrição | | -------------- | ------------------------------------------------------------------------------------------------------------- | | `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | | `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | | `conflicted` | Displays `conflicted` when this branch has merge conflicts. | | `untracked` | Displays `untracked` when there are untracked files in the working directory. | | `stashed` | Displays `stashed` when a stash exists for the local repository. | | `modified` | Displays `modified` when there are file modifications in the working directory. | | `staged` | Displays `staged` when a new file has been added to the staging area. | | `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | style\* | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo The following variables can be used in `diverged`: | Variável | Descrição | | -------------- | ---------------------------------------------- | | `ahead_count` | Number of commits ahead of the tracking branch | | `behind_count` | Number of commits behind the tracking branch | The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: | Variável | Descrição | | -------- | ------------------------ | | `count` | Show the number of files | ### Exemplo ```toml # ~/.config/starship.toml [git_status] conflicted = '🏳' ahead = '🏎💨' behind = '😰' diverged = '😵' up_to_date = '✓' untracked = '🤷' stashed = '📦' modified = '📝' staged = '[++\($count\)](green)' renamed = '👅' deleted = '🗑' ``` Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml [git_status] ahead = '⇡${count}' diverged = '⇕⇡${ahead_count}⇣${behind_count}' behind = '⇣${count}' ``` Use Windows Starship executable on Windows paths in WSL ```toml # ~/.config/starship.toml [git_status] windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe' ``` ## Go The `golang` module shows the currently installed version of [Go](https://golang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `go.mod` - O diretório atual conter um arquivo `go.sum` - O diretório atual conter um arquivo `go.work` - O diretório atual conter 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}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐹 '` | A format string representing the symbol of Go. | | `detect_extensions` | `['go']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['go.mod', 'go.sum', 'go.work', '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` | Disables the `golang` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | | version | `v1.12.1` | The version of `go` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [golang] format = 'via [🏎💨 $version](bold cyan) ' ``` ## Guix-shell The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. ### Opções | Opções | Padrão | Descrição | | ---------- | -------------------------- | ------------------------------------------------------ | | `format` | `'via [$symbol]($style) '` | O formato do módulo. | | `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `style` | `"yellow bold"` | O estilo do módulo. | | `disabled` | `false` | Disables the `guix_shell` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [guix_shell] disabled = true format = 'via [🐂](yellow bold) ' ``` ## Gradle The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. - The current directory contains a file ending with `.gradle` or `.gradle.kts`. The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | | `detect_extensions` | `["gradle", "gradle.kts"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `["gradle"]` | Quais pastas devem ativar este módulo. | | `style` | `"bold bright-cyan"` | O estilo do módulo. | | `disabled` | `false` | Disables the `gradle` module. | | `recursive` | `false` | Enables recursive finding for the `gradle` directory. | ### Variáveis | Variável | Exemplo | Descrição | | -------- | -------- | --------------------------------- | | version | `v7.5.1` | The version of `gradle` | | symbol | | Espelha o valor da opção `symbol` | | style* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `stack.yaml` - O diretório atual contém qualquer arquivo `.hs`, `.cabal`, ou `.hs-boot` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | -------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `symbol` | `'λ '` | A format string representing the symbol of Haskell | | `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['stack.yaml', 'cabal.project']` | 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` | Disables the `haskell` module. | ### Variáveis | Variável | Exemplo | Descrição | | -------------- | ----------- | --------------------------------------------------------------------------------------- | | version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | | snapshot | `lts-18.12` | Currently selected Stack snapshot | | ghc\_version | `9.2.1` | Currently installed GHC version | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ## Haxe The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file - The current directory contains a `.haxelib` or a `haxe_libraries` directory - The current directory contains a file with the `.hx` or `.hxml` extension ### Opções | Opções | Padrão | Descrição | | ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["hx", "hxml"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[".haxelib", "haxe_libraries"]` | Quais pastas devem ativar este módulo. | | `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `style` | `"bold fg:202"` | O estilo do módulo. | | `disabled` | `false` | Disables the `haxe` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | | version | `v4.2.5` | The version of `haxe` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [haxe] format = "via [⌘ $version](bold fg:202) " ``` ## Helm The `helm` module shows the currently installed version of [Helm](https://helm.sh/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter 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}'` | A versão formatada. 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` | `'⎈ '` | A format string representing the symbol of Helm. | | `style` | `'bold white'` | O estilo do módulo. | | `disabled` | `false` | Disables the `helm` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | | version | `v3.1.1` | The version of `helm` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [helm] format = 'via [⎈ $version](bold white) ' ``` ## Hostname The `hostname` module shows the system hostname. ### Opções | Opções | Padrão | Descrição | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | | `format` | `'[$ssh_symbol$hostname]($style) in '` | O formato do módulo. | | `style` | `'bold dimmed green'` | O estilo do módulo. | | `disabled` | `false` | Disables the `hostname` module. | ### Variáveis | Variável | Exemplo | Descrição | | ---------- | ---------- | ----------------------------------------------------- | | hostname | `computer` | The hostname of the computer | | style\* | | Espelha o valor da opção `style` | | ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [hostname] ssh_only = false format = '[$ssh_symbol](bold blue) on [$hostname](bold red) ' trim_at = '.companyname.com' disabled = false ``` ## Java The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, or `build.boot` file - 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}'` | A versão formatada. 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` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | O estilo do módulo. | | `disabled` | `false` | Disables the `java` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | | version | `v14` | The version of `java` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [java] symbol = '🌟 ' ``` ## Jobs The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: - 0 jobs -> Nada é exibido. - 1 job -> `symbol` é exibido. - 2 jobs or more -> `symbol` + `number` é exibido. ::: atenção This module is not supported on tcsh and nu. ::: ::: atenção The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: ### Opções | Opções | Padrão | Descrição | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | | `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `'[$symbol$number]($style) '` | O formato do módulo. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | O estilo do módulo. | | `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | | number | `1` | The number of jobs | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [jobs] symbol = '+ ' number_threshold = 4 symbol_threshold = 0 ``` ## Julia The `julia` module shows the currently installed version of [Julia](https://julialang.org/). 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}'` | A versão formatada. 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` | `'ஃ '` | A format string representing the symbol of Julia. | | `style` | `'bold purple'` | O estilo do módulo. | | `disabled` | `false` | Disables the `julia` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | | version | `v1.4.0` | The version of `julia` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [julia] symbol = '∴ ' ``` ## Kotlin The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `.kt` ou 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}'` | A versão formatada. 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` | `'🅺 '` | A format string representing the symbol of Kotlin. | | `style` | `'bold blue'` | O estilo do módulo. | | `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | | `disabled` | `false` | Disables the `kotlin` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | | version | `v1.4.21` | The version of `kotlin` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [kotlin] symbol = '🅺 ' ``` ```toml # ~/.config/starship.toml [kotlin] # Uses the Kotlin Compiler binary to get the installed version kotlin_binary = 'kotlinc' ``` ## Kubernetes Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. ::: ### 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` | `{}` | Table of context aliases to display. | | `user_aliases` | `{}` | Table of user aliases to display. | | `detect_extensions` | `[]` | 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` | `true` | Disables the `kubernetes` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------------------- | ---------------------------------------- | | context | `starship-context` | The current kubernetes context name | | namespace | `starship-namespace` | If set, the current kubernetes namespace | | user | `starship-user` | If set, the current kubernetes user | | cluster | `starship-cluster` | If set, the current kubernetes cluster | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [kubernetes] format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) ' disabled = false [kubernetes.context_aliases] 'dev.local.cluster.k8s' = 'dev' '.*/openshift-cluster/.*' = 'openshift' 'gke_.*_(?P[\\w-]+)' = 'gke-$var_cluster' [kubernetes.user_aliases] 'dev.local.cluster.k8s' = 'dev' 'root/.*' = 'root' ``` Only show the module in directories that contain a `k8s` file. ```toml # ~/.config/starship.toml [kubernetes] disabled = false detect_files = ['k8s'] ``` #### Correspondência Regex Additional to simple aliasing, `context_aliases` and `user_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](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation. Long and automatically generated cluster names can be identified and shortened using regular expressions: ```toml [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[\\w-]+)/.*' = '$var_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[\\w-]+)' = 'gke-$var_cluster' ``` ## Line Break The `line_break` module separates the prompt into two lines. ### Opções | Opções | Padrão | Descrição | | ---------- | ------- | ------------------------------------------------------------------ | | `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Exemplo ```toml # ~/.config/starship.toml [line_break] disabled = true ``` ## Local IP The `localip` module shows the IPv4 address of the primary network interface. ### Opções | Opções | Padrão | Descrição | | ---------- | ------------------------- | ------------------------------------------------------ | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `format` | `'[$localipv4]($style) '` | O formato do módulo. | | `style` | `'bold yellow'` | O estilo do módulo. | | `disabled` | `true` | Disables the `localip` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------ | --------------------------------- | | localipv4 | 192.168.1.13 | Contains the primary IPv4 address | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [localip] ssh_only = false format = '@[$localipv4](bold red) ' disabled = false ``` ## Lua The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contém um arquivo `.lua-version` - O diretório atual contém um diretório `lua` - O diretório atual tem um arquivo com a extensão `.lua` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [lua] format = 'via [🌕 $version](bold blue) ' ``` ## Memory Usage 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 This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 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 ```toml # ~/.config/starship.toml [memory_usage] disabled = false threshold = -1 symbol = ' ' style = 'bold dimmed green' ``` ## Meson The `meson` module shows the current Meson developer environment status. By default the Meson project name is displayed, if `$MESON_DEVENV` is set. ### Opções | Opções | Padrão | Descrição | | ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- | | `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. | | `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. | | `format` | `'via [$symbol$project]($style) '` | O formato do módulo. | | `symbol` | `'⬢ '` | The symbol used before displaying the project name. | | `style` | `'blue bold'` | O estilo do módulo. | | `disabled` | `false` | Disables the `meson` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | | project | `starship` | The current Meson project name | | symbol | `🐏` | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [meson] disabled = false truncation_symbol = '--' symbol = ' ' style = 'bold dimmed green' ``` ## Mercurial Branch The `hg_branch` module shows the active branch and topic 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(:$topic)]($style) '` | O formato do módulo. | | `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | | `disabled` | `true` | Disables the `hg_branch` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | | branch | `master` | The active mercurial branch | | topic | `feature` | The active mercurial topic | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.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](https://nim-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `nim.cfg` - O diretório atual tenha um arquivo com a extensão `.nim` - O diretório atual tenha um arquivo com a extensão `.nims` - O diretório atual tenha um arquivo com a extensão `.nimble` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | The format for the module | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [nim] style = 'yellow' symbol = '🎣 ' ``` ## Nix-shell The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) 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. | | `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | | `disabled` | `false` | Disables the `nix_shell` module. | | `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [nix_shell] disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` ## Node.js The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `package.json` - O diretório atual tenha um arquivo `.node-version` - O diretório atual tenha um arquivo`.nvmrc` - O diretório atual tenha um diretório `node_modules` - O diretório atual tenha um arquivo com a extensão `.js`, `.mjs` or `.cjs` - O diretório atual contém um arquivo com a extensão `.ts`, `.mts` ou `.cts` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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', 'mts', 'cts']` | 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [nodejs] format = 'via [🤖 $version](bold green) ' ``` ## OCaml The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contenha um arquivo com a extensão`.opam` ou um diretório `_opam` - O diretório atual tenha um diretório `esy.lock` - O diretório atual tenha um arquivo `dune` or `dune-project` - O diretório atual tenha um arquivo `jbuild` or `jbuild-ignore` - O diretório tenha um arquivo `.merlin` - O diretório atual tenha um arquivo com a extensão `.ml`, `.mli`, `.re` ou `.rei` ### Opções | Opções | Padrão | Descrição | | ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [ocaml] format = 'via [🐪 $version]($style) ' ``` ## Open Policy Agent The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file. ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🪖 '` | A format string representing the symbol of OPA. | | `detect_extensions` | `['rego']` | 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` | `'bold blue'` | O estilo do módulo. | | `disabled` | `false` | Disables the `opa` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | | version | `v0.44.0` | The version of `opa` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [opa] format = 'via [⛑️ $version](bold red) ' ``` ## 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](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [openstack] format = 'on [$symbol$cloud(\($project\))]($style) ' style = 'bold yellow' symbol = '☁️ ' ``` ## OS The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. ::: atenção The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. ::: ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções | Opções | Padrão | Descrição | | ---------- | --------------------- | ------------------------------------------------------ | | `format` | `"[$symbol]($style)"` | O formato do módulo. | | `style` | `"bold white"` | O estilo do módulo. | | `disabled` | `true` | Disables the `os` module. | | `symbols` | | A table that maps each operating system to its symbol. | `symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https://github.com/starship/starship/issues/new/choose). ```toml # This is the default symbols table. [os.symbols] Alpine = "🏔️ " Amazon = "🙂 " Android = "🤖 " Arch = "🎗️ " CentOS = "💠 " Debian = "🌀 " DragonFly = "🐉 " Emscripten = "🔗 " EndeavourOS = "🚀 " Fedora = "🎩 " FreeBSD = "😈 " Garuda = "🦅 " Gentoo = "🗜️ " HardenedBSD = "🛡️ " Illumos = "🐦 " Linux = "🐧 " Macos = "🍎 " Manjaro = "🥭 " Mariner = "🌊 " MidnightBSD = "🌘 " Mint = "🌿 " NetBSD = "🚩 " NixOS = "❄️ " OpenBSD = "🐡 " openSUSE = "🦎 " OracleLinux = "🦴 " Pop = "🍭 " Raspbian = "🍓 " Redhat = "🎩 " RedHatEnterprise = "🎩 " Redox = "🧪 " Solus = "⛵ " SUSE = "🦎 " Ubuntu = "🎯 " Unknown = "❓ " Windows = "🪟 " ``` ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------ | ------------------------------------------------------------------ | | symbol | `🎗️` | The current operating system symbol from advanced option `symbols` | | name | `Arch Linux` | The current operating system name | | type | `Arch` | The current operating system type | | codename | | The current operating system codename, if applicable | | edition | | The current operating system edition, if applicable | | version | | The current operating system version, if applicable | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [os] format = "on [($name )]($style)" style = "bold blue" disabled = false [os.symbols] Windows = " " Arch = "Arch is the best! " ``` ## 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`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – O versionamento de pacotes `npm` é extraído do `package.json` presente no diretório atual - [**Cargo**](https://doc.rust-lang.org/cargo/) – O versionamento de pacotes `cargo`é extraído do arquivo `Cargo.toml` presente no diretório atual - [**Nimble**](https://github.com/nim-lang/nimble) - O versionamento de pacotes `nimble` é extraído do arquivo `*.nimble` presente no diretório atual com o comando`nimble dump` - [**Poetry**](https://python-poetry.org/) – O versionamento de pacotes `poetry` é extraído do arquivo `pyproject.toml` presente no diretório atual - [**Python**](https://www.python.org) - O versionamento de pacotes `python` é extraída de um `pyproject.toml` compatível com [PEP 621](https://peps.python.org/pep-0621/) ou um `setup.cfg` presente no diretório atual - [**Composer**](https://getcomposer.org/) – O versionamento de pacotes `composer` é extraído do arquivo`composer.json` presente no diretório atual - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [**SBT**](https://scala-sbt.org) - O versionamento de pacotes `sbt` pé extraído do arquivo `build.sbt` presente no diretório atual - [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory - [**Dart**](https://pub.dev/) - O versionamento de pacotes `dart` pé extraído do arquivo `pubspec.yaml` presente no diretório atual > ⚠️ A versão exibida é a que esta presente no código fonte do diretório atual e não do gerenciador de pacotes. ### 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}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [package] format = 'via [🎁 $version](208 bold) ' ``` ## Perl The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual tanha um aquivo `Makefile.PL` ou `Build.PL` - O diretório atual tenha um arquivo `cpanfile` ou `cpanfile.snapshot` - O diretório atual tenha um arquivo `META.json` ou `META.yml` - O diretório atual tenha um arquivo `.perl-version` - O diretório atual tenha um `.pl`, `.pm` ou `.pod` ### Opções | Opções | Padrão | Descrição | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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 ```toml # ~/.config/starship.toml [perl] format = 'via [🦪 $version]($style) ' ``` ## PHP The `php` module shows the currently installed version of [PHP](https://www.php.net/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `composer.json` - O diretório atual tenha um arquivo `.php-version` - O diretório atual tenha um arquivo com extensão `.php` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [php] format = 'via [🔹 $version](147 bold) ' ``` ## Pijul Channel The `pijul_channel` module shows the active channel of the repo in your current directory. ### Opções | Opções | Padrão | Descrição | | ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | | `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | | `style` | `'bold purple'` | O estilo do módulo. | | `format` | `'on [$symbol$channel]($style) '` | O formato do módulo. | | `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | | `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | | `disabled` | `true` | Disables the `pijul` module. | ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/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](#with-pulumi-version). ::: Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual tenha um arquivo `Pulumi.yaml` ou `Pulumi.yml` - A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false` ### Opções | Opções | Padrão | Descrição | | ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($username@)$stack]($style) '` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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. | | `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. | | `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 | | username | `alice` | The current Pulumi username | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo #### Com a versão do Pulumi ```toml # ~/.config/starship.toml [pulumi] format = '[🛥 ($version )$stack]($style) ' ``` #### Sem a versão do Pulumi ```toml # ~/.config/starship.toml [pulumi] symbol = '🛥 ' format = '[$symbol$stack]($style) ' ``` ## PureScript The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `spago.dhall` - O diretório atual tenha um arquivo com a extensão `.purs` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [purescript] format = 'via [$symbol$version](bold white)' ``` ## Python The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) 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: - O diretório atual tenha um arquivo `.python-version` - O diretório atual tenha um arquivo `Pipfile` - O diretório atual tenha um arquivo `__init__.py` - O diretório atual conter um arquivo `pyproject.toml` - O diretório atual conter um arquivo `requirements.txt` - O diretório atual conter um arquivo `setup.py` - O diretório atual conter um arquivo `tox.ini` - O diretório atual tenha um arquivo com a extensão `.py`. - Um ambiente virtual está atualmente ativo ### 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}'` | A versão formatada. 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 ```toml # ~/.config/starship.toml [python] symbol = '👾 ' pyenv_version_name = true ``` ```toml # ~/.config/starship.toml [python] # Only use the `python3` binary to get the version. python_binary = 'python3' ``` ```toml # ~/.config/starship.toml [python] # Don't trigger for files with the py extension detect_extensions = [] ``` ```toml # ~/.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](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - O diretório atual tenha um arquivo com a extensão `.R`. - O diretório atual tenha um arquivo com a extensão `.Rd`. - O diretório atual tenha um arquivo com a extensão `.Rmd`. - O diretório atual tenha um arquivo com a extensão `.Rproj`. - O diretório atual tenha um arquivo com a extensão `.Rsx`. - O diretório atual tenha um arquivo `.Rprofile` - O diretório atual tenha uma pasta `.Rpoj.user` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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 ```toml # ~/.config/starship.toml [rlang] format = 'with [📐 $version](blue bold) ' ``` ## Raku The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - The current directory contains a `META6.json` file - The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version-$vm_version )]($style)'` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku | | `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['META6.json']` | 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 `raku` module. | ### Variáveis | Variável | Exemplo | Descrição | | ---------- | ------- | ------------------------------------ | | version | `v6.d` | The version of `raku` | | vm_version | `moar` | The version of VM `raku` is built on | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | ### Exemplo ```toml # ~/.config/starship.toml [raku] format = 'via [🦪 $version]($style) ' ``` ## Red By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - O diretório atual contenha um arquivo com a extensão `.red` or `.reds` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [red] symbol = '🔴 ' ``` ## Ruby By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - O diretório atual tenha um arquivo `Gemfile` - O diretório atual contém um arquivo `.ruby-version` - O diretório atual contem um arquivo `.rb` - As variáveis de ambiente `RUBY_VERSION` ou `RBENV_VERSION` estão definidas 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}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [ruby] symbol = '🔺 ' ``` ## Rust By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - O diretório atual contem um arquivo `Cargo.toml` - O diretório atual tenha um arquivo com a extensão `.rs` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | | numver | `1.51.0` | The numeric component of the `rustc` version | | toolchain | `beta` | The toolchain version | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [rust] format = 'via [⚙️ $version](red bold)' ``` ## Scala The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `build.sbt`, `.scalaenv` ou `.sbtenv` - O diretório atual tenha um arquivo com a extensão `.scala` ou `.sbt` - O diretório atual tenha um diretório chamado `.metals` ### Opções | Opções | Padrão | Descrição | | ------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [${symbol}(${version} )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [scala] symbol = '🌟 ' ``` ## Shell The `shell` module shows an indicator for currently used shell. ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 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. | | `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | | `nu_indicator` | `'nu'` | A format string used to represent nu. | | `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`. | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplos ```toml # ~/.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`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [shlvl] disabled = false format = '$shlvl level(s) down' threshold = 3 ``` ## Singularidade The `singularity` module shows the current [Singularity](https://sylabs.io/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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [singularity] format = '[📦 \[$env\]]($style) ' ``` ## Spack The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. ### Opções | Opções | Padrão | Descrição | | ------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` quer dizer sem truncação. Também consulte o módulo [`directory`](#directory). | | `symbol` | `'🅢 '` | O simbolo usado antes do nome do environment. | | `style` | `'bold blue'` | O estilo do módulo. | | `format` | `'via [$symbol$environment]($style) '` | O formato do módulo. | | `disabled` | `false` | Disables the `spack` module. | ### Variáveis | Variável | Exemplo | Descrição | | ----------- | ------------ | --------------------------------- | | environment | `astronauts` | The current spack environment | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [spack] format = '[$symbol$environment](dimmed blue) ' ``` ## Status The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 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` | | | The symbol used to separate pipestatus segments (supports formatting) | | `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline | | `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments | | `disabled` | `true` | Disables the `status` module. | ### Variáveis | Variável | Exemplo | Descrição | | -------------- | ------- | ------------------------------------------------------------------------------------------- | | status | `127` | The exit code of the last command | | hex_status | `0x7F` | The exit code of the last command in hex | | 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [status] style = 'bg:blue' symbol = '🔴 ' success_symbol = '🟢 SUCCESS' format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` ## Sudo The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções | Opções | Padrão | Descrição | | --------------- | ------------------------ | ------------------------------------------------------- | | `format` | `'[as $symbol]($style)'` | The format of the module | | `symbol` | `'🧙 '` | The symbol displayed when credentials are cached | | `style` | `'bold blue'` | O estilo do módulo. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | | `disabled` | `true` | Disables the `sudo` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [sudo] style = 'bold green' symbol = '👩‍💻 ' disabled = false ``` ```toml # On windows # $HOME\.starship\config.toml [sudo] allow_windows = true disabled = false ``` ## Swift By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - O diretório atual tenha um arquivo `Package.swift` - O diretório atual tenha um arquivo com a extensão `.swift` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [swift] format = 'via [🏎 $version](red bold)' ``` ## Terraform The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) 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](#with-terraform-version). ::: Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual tenha uma pasta `.terraform` - O diretório atual tenha arquivos com as extensões `.tf`, `.tfplan` or `.tfstate` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol$workspace]($style) '` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo #### Com a versão do Terraform ```toml # ~/.config/starship.toml [terraform] format = '[🏎💨 $version$workspace]($style) ' ``` #### Sem a versão do Terraform ```toml # ~/.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`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções | Opções | Padrão | Descrição | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `format` | `'at [$time]($style) '` | A string de formato do módulo. | | `use_12hr` | `false` | Enables 12 hour formatting | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.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: - O usuário atual é root/admin - O usuário atual não é o mesmo que está logado - O usuário atual esta conectado em uma sessão SSH - A variável `show_always` esta definida como 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/admin. | | `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 ```toml # ~/.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](https://www.vagrantup.com/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `Vagrantfile` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [vagrant] format = 'via [⍱ $version](bold white) ' ``` ## V The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual cotem qualquer arquivo com a extensão `.v` - O diretório atual contem um arquivo `v.mod`, `vpkg.json` ou `.vpkg-lock.json` ### Opções | Opções | Padrão | Descrição | | ------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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 ```toml # ~/.config/starship.toml [vlang] format = 'via [V $version](blue bold) ' ``` ## VCSH The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.config/starship.toml [vcsh] format = '[🆅 $repo](bold blue) ' ``` ## Zig By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - O diretório atual contém arquivo com a extensão `.zig` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. 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` | *: Esta variável só pode ser usada como parte de uma string de estilo ### Exemplo ```toml # ~/.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: - O diretório atual contém um arquivo cujo nome está em `detect_files` - O diretório atual contém um diretório cujo nome está em `detect_folders` - O diretório atual contém um arquivo cuja extensão está em `detect_extensions` - O comando `when` retorna 0 - The current Operating System (std::env::consts::OS) matches with `os` field 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](https://github.com/starship/starship/discussions/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](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ::: ### 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` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | | `description` | `''` | The description of the module that is shown when running `starship explain`. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_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](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | | `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | ### 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` | *: Esta variável só pode ser usada como parte de uma string de estilo #### Comandos personalizados de shell `shell` accepts a non-empty list of strings, where: - A primeira string é o caminho para o shell que executará o comando. - Outros argumentos que serão passados para o 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 -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. ```toml 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](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ::: ### Exemplo ```toml # ~/.config/starship.toml [custom.foo] command = 'echo foo' # shows output of command detect_files = ['foo'] # can specify filters but wildcards are not supported when = ''' test "$HOME" = "$PWD" ''' format = ' transcending [$output]($style)' [custom.time] command = 'time /T' detect_extensions = ['pst'] # filters *.pst files shell = ['pwsh.exe', '-NoProfile', '-Command', '-'] [custom.time-as-arg] command = 'time /T' detect_extensions = ['pst'] # filters *.pst files shell = ['pwsh.exe', '-NoProfile', '-Command'] use_stdin = false ```