mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-25 06:07:43 +00:00
779e53cd66
* add feature - sudo module * add sudo module identifiers and entry point * fix test test_sudo_not_cached * add test test_sudo_cached * add `allow_windows` and `binary` options * rustfmt sudo_x_cached and rmv them on windows * add false `allow_windows` block windows test * add `doas` cached/not_cached tests * better description in `starship explain` * fix `test_doas_cached` with `-n` flag Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * rmv `binary` alternatives and their tests * fix symbol and update config/README * fix all mocks to use `sudo -n true` * fix expected output in `test_sudo_cached` * proper checking for blocked sudo Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * add `allow_windows = true` to non-windows tests * allow sudo_* tests to run on windows + fix parsed * rustfmt `blocks_windows` test Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
541 lines
8.3 KiB
Markdown
541 lines
8.3 KiB
Markdown
# Presets
|
||
|
||
Here is a collection of community-submitted configuration presets for Starship.
|
||
If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
|
||
|
||
## Nerd Font Symbols
|
||
|
||
This preset doesn't change anything except for the symbols used for each module.
|
||
If emojis aren't your thing, this might catch your eye!
|
||
|
||
![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png)
|
||
|
||
### Prerequisites
|
||
|
||
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)
|
||
|
||
### Configuration
|
||
|
||
```toml
|
||
[aws]
|
||
symbol = " "
|
||
|
||
[conda]
|
||
symbol = " "
|
||
|
||
[dart]
|
||
symbol = " "
|
||
|
||
[directory]
|
||
read_only = " "
|
||
|
||
[docker_context]
|
||
symbol = " "
|
||
|
||
[elixir]
|
||
symbol = " "
|
||
|
||
[elm]
|
||
symbol = " "
|
||
|
||
[git_branch]
|
||
symbol = " "
|
||
|
||
[golang]
|
||
symbol = " "
|
||
|
||
[hg_branch]
|
||
symbol = " "
|
||
|
||
[java]
|
||
symbol = " "
|
||
|
||
[julia]
|
||
symbol = " "
|
||
|
||
[memory_usage]
|
||
symbol = " "
|
||
|
||
[nim]
|
||
symbol = " "
|
||
|
||
[nix_shell]
|
||
symbol = " "
|
||
|
||
[package]
|
||
symbol = " "
|
||
|
||
[perl]
|
||
symbol = " "
|
||
|
||
[php]
|
||
symbol = " "
|
||
|
||
[python]
|
||
symbol = " "
|
||
|
||
[ruby]
|
||
symbol = " "
|
||
|
||
[rust]
|
||
symbol = " "
|
||
|
||
[scala]
|
||
symbol = " "
|
||
|
||
[shlvl]
|
||
symbol = " "
|
||
|
||
[swift]
|
||
symbol = "ﯣ "
|
||
```
|
||
|
||
## Bracketed Segments
|
||
|
||
This preset changes the format of all the built-in modules to show their segment
|
||
in brackets instead of using the default Starship wording ("via", "on", etc.).
|
||
|
||
Before:
|
||
|
||
![Screenshot of default Starship configuration](/presets/bracketed-segments-before.png)
|
||
|
||
After:
|
||
|
||
![Screenshot of Bracketed Segments preset](/presets/bracketed-segments-after.png)
|
||
|
||
### Configuration
|
||
|
||
```toml
|
||
[aws]
|
||
format = '\[[$symbol($profile)(\($region\))(\[$duration\])]($style)\]'
|
||
|
||
[cmake]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[cmd_duration]
|
||
format = '\[[⏱ $duration ]($style)\]'
|
||
|
||
[cobol]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[conda]
|
||
format = '\[[$symbol$environment]($style)\]'
|
||
|
||
[crystal]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[dart]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[deno]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[docker_context]
|
||
format = '\[[$symbol$context]($style)\]'
|
||
|
||
[dotnet]
|
||
format = '\[[$symbol($version)(🎯 $tfm)]($style)\]'
|
||
|
||
[elixir]
|
||
format = '\[[$symbol($version \(OTP $otp_version\))]($style)\]'
|
||
|
||
[elm]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[erlang]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[gcloud]
|
||
format = '\[[$symbol$account(@$domain)(\($region\))]($style)\]'
|
||
|
||
[git_branch]
|
||
format = '\[[$symbol$branch]($style)\]'
|
||
|
||
[git_status]
|
||
format = '([\[$all_status$ahead_behind\]]($style))'
|
||
|
||
[golang]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[helm]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[hg_branch]
|
||
format = '\[[$symbol$branch]($style)\]'
|
||
|
||
[java]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[julia]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[kotlin]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[kubernetes]
|
||
format = '\[[$symbol$context( \($namespace\))]($style)\]'
|
||
|
||
[lua]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[memory_usage]
|
||
format = '\[$symbol[$ram( | $swap)]($style)\]'
|
||
|
||
[nim]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[nix_shell]
|
||
format = '\[[$symbol$state( \($name\))]($style)\]'
|
||
|
||
[nodejs]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[ocaml]
|
||
format = '\[[$symbol($version)(\($switch_indicator$switch_name\))]($style)\]'
|
||
|
||
[openstack]
|
||
format = '\[[$symbol$cloud(\($project\))]($style)\]'
|
||
|
||
[package]
|
||
format = '\[[$symbol$version]($style)\]'
|
||
|
||
[perl]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[php]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[pulumi]
|
||
format = '\[[$symbol$stack]($style)\]'
|
||
|
||
[purescript]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[python]
|
||
format = '\[[${symbol}${pyenv_prefix}(${version})(\($virtualenv\))]($style)\]'
|
||
|
||
[red]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[ruby]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[rust]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[scala]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[sudo]
|
||
format = '\[[as $symbol]\]
|
||
|
||
[swift]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[terraform]
|
||
format = '\[[$symbol$workspace]($style)\]'
|
||
|
||
[time]
|
||
format = '\[[$time]($style)\]'
|
||
|
||
[username]
|
||
format = '\[[$user]($style)\]'
|
||
|
||
[vagrant]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[vlang]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
|
||
[zig]
|
||
format = '\[[$symbol($version)]($style)\]'
|
||
```
|
||
|
||
## Plain Text Symbols
|
||
|
||
This preset changes the symbols into plain text.
|
||
If your terminal/font could not render the NerdFonts/emojis, maybe you could try this preset!
|
||
|
||
Before (default setting with Fixedsys font):
|
||
|
||
![Screenshot of default Starship configuration with Fixedsys font](/presets/plain-text-symbols-before.png)
|
||
|
||
After (Plain Text Symbols):
|
||
|
||
![Screenshot of Plain Text Symbols preset](/presets/plain-text-symbols-after.png)
|
||
|
||
### Configuration
|
||
|
||
```toml
|
||
[character]
|
||
success_symbol = "[>](bold green)"
|
||
error_symbol = "[x](bold red)"
|
||
vicmd_symbol = "[<](bold green)"
|
||
|
||
[git_commit]
|
||
tag_symbol = " tag "
|
||
|
||
[git_status]
|
||
ahead = ">"
|
||
behind = "<"
|
||
diverged = "<>"
|
||
renamed = "r"
|
||
deleted = "x"
|
||
|
||
[aws]
|
||
symbol = "aws "
|
||
|
||
[cobol]
|
||
symbol = "cobol "
|
||
|
||
[conda]
|
||
symbol = "conda "
|
||
|
||
[crystal]
|
||
symbol = "cr "
|
||
|
||
[cmake]
|
||
symbol = "cmake "
|
||
|
||
[dart]
|
||
symbol = "dart "
|
||
|
||
[deno]
|
||
symbol = "deno "
|
||
|
||
[dotnet]
|
||
symbol = ".NET "
|
||
|
||
[directory]
|
||
read_only = " ro"
|
||
|
||
[docker_context]
|
||
symbol = "docker "
|
||
|
||
[elixir]
|
||
symbol = "exs "
|
||
|
||
[elm]
|
||
symbol = "elm "
|
||
|
||
[git_branch]
|
||
symbol = "git "
|
||
|
||
[golang]
|
||
symbol = "go "
|
||
|
||
[hg_branch]
|
||
symbol = "hg "
|
||
|
||
[java]
|
||
symbol = "java "
|
||
|
||
[julia]
|
||
symbol = "jl "
|
||
|
||
[kotlin]
|
||
symbol = "kt "
|
||
|
||
[nodejs]
|
||
symbol = "nodejs "
|
||
|
||
[memory_usage]
|
||
symbol = "memory "
|
||
|
||
[nim]
|
||
symbol = "nim "
|
||
|
||
[nix_shell]
|
||
symbol = "nix "
|
||
|
||
[ocaml]
|
||
symbol = "ml "
|
||
|
||
[package]
|
||
symbol = "pkg "
|
||
|
||
[perl]
|
||
symbol = "pl "
|
||
|
||
[php]
|
||
symbol = "php "
|
||
|
||
[pulumi]
|
||
symbol = "pulumi "
|
||
|
||
[purescript]
|
||
symbol = "purs "
|
||
|
||
[python]
|
||
symbol = "py "
|
||
|
||
[ruby]
|
||
symbol = "rb "
|
||
|
||
[rust]
|
||
symbol = "rs "
|
||
|
||
[scala]
|
||
symbol = "scala "
|
||
|
||
[sudo]
|
||
symbol = "sudo "
|
||
|
||
[swift]
|
||
symbol = "swift "
|
||
```
|
||
|
||
## Hide Runtime Versions
|
||
|
||
This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you!
|
||
|
||
![Screenshot of Hide Runtime Versions preset](/presets/hide-runtime-versions.png)
|
||
|
||
### Configuration
|
||
|
||
```toml
|
||
[cmake]
|
||
format = "via [$symbol]($style)"
|
||
|
||
[cobol]
|
||
format = "via [$symbol]($style)"
|
||
|
||
[crystal]
|
||
format = "via [$symbol]($style)"
|
||
|
||
[dart]
|
||
format = "via [$symbol]($style)"
|
||
|
||
[deno]
|
||
format = "via [$symbol]($style)"
|
||
|
||
[dotnet]
|
||
format = "[$symbol(🎯 $tfm )]($style)"
|
||
|
||
[elixir]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[elm]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[erlang]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[golang]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[helm]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[julia]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[kotlin]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[lua]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[nim]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[nodejs]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[ocaml]
|
||
format = 'via [$symbol(\($switch_indicator$switch_name\) )]($style)'
|
||
|
||
[perl]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[php]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[pulumi]
|
||
format = 'via [$symbol$stack]($style)'
|
||
|
||
[purescript]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[red]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[rlang]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[ruby]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[rust]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[swift]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[vagrant]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[vlang]
|
||
format = 'via [$symbol]($style)'
|
||
|
||
[zig]
|
||
format = 'via [$symbol]($style)'
|
||
```
|
||
|
||
## Pure
|
||
|
||
This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure).
|
||
|
||
![Screenshot of Pure preset](/presets/pure-prompt.png)
|
||
|
||
### Configuration
|
||
|
||
```toml
|
||
format = """
|
||
$username\
|
||
$hostname\
|
||
$directory\
|
||
$git_branch\
|
||
$git_state\
|
||
$git_status\
|
||
$cmd_duration\
|
||
$line_break\
|
||
$python\
|
||
$character"""
|
||
|
||
[directory]
|
||
style = "blue"
|
||
|
||
[character]
|
||
success_symbol = "[❯](purple)"
|
||
error_symbol = "[❯](red)"
|
||
vicmd_symbol = "[❮](green)"
|
||
|
||
[git_branch]
|
||
format = "[$branch]($style)"
|
||
style = "bright-black"
|
||
|
||
[git_status]
|
||
format = "[[(*$conflicted$untracked$modified$staged$renamed$deleted)](218) ($ahead_behind$stashed)]($style)"
|
||
style = "cyan"
|
||
conflicted = ""
|
||
untracked = ""
|
||
modified = ""
|
||
staged = ""
|
||
renamed = ""
|
||
deleted = ""
|
||
stashed = "≡"
|
||
|
||
[git_state]
|
||
format = '\([$state( $progress_current/$progress_total)]($style)\) '
|
||
style = "bright-black"
|
||
|
||
[cmd_duration]
|
||
format = "[$duration]($style) "
|
||
style = "yellow"
|
||
|
||
[python]
|
||
format = "[$virtualenv]($style) "
|
||
style = "bright-black"
|
||
```
|