├── .editorconfig ├── LICENSE ├── README.md ├── assets ├── .gitkeep └── preview.webp ├── justfile ├── renovate.json ├── starship.toml ├── templates ├── example.tera └── starship.tera └── themes ├── frappe.toml ├── latte.toml ├── macchiato.toml └── mocha.toml /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig helps developers define and maintain consistent 2 | # coding styles between different editors and IDEs 3 | # EditorConfig is awesome: https://EditorConfig.org 4 | 5 | root = true 6 | 7 | [*] 8 | charset = utf-8 9 | indent_size = 2 10 | indent_style = space 11 | end_of_line = lf 12 | insert_final_newline = true 13 | trim_trailing_whitespace = true 14 | 15 | # go 16 | [*.go] 17 | indent_style = tab 18 | indent_size = 4 19 | 20 | # python 21 | [*.{ini,py,py.tpl,rst}] 22 | indent_size = 4 23 | 24 | # rust 25 | [*.rs] 26 | indent_size = 4 27 | 28 | # documentation, utils 29 | [*.{md,mdx,diff}] 30 | trim_trailing_whitespace = false 31 | 32 | # windows shell scripts 33 | [*.{cmd,bat,ps1}] 34 | end_of_line = crlf 35 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Catppuccin 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | Logo
3 | 4 | Catppuccin for Starship 5 | 6 |

7 | 8 |

9 | 10 | 11 | 12 |

13 | 14 |

15 | 16 |

17 | 18 | ## Usage 19 | 20 | 1. Copy one or all of the flavor palettes from [`themes/`](./themes/) to your [Starship configuration file](https://starship.rs/config/). 21 | 2. Set `palette = "catppuccin_"`, preferably at the top of your config. Palette tables must be defined under this line. 22 | 3. Save and reload your prompt. 23 | 24 | > [!TIP] 25 | > Check out this [example Starship configuration](starship.toml) for how to define and use colors from custom palettes. 26 | 27 | ## 💝 Thanks to 28 | 29 | - [bexli](https://github.com/joshpaulie) ("Maintainer") 30 | - [uncenter](https://github.com/uncenter) (Catppuccin Whiskers Compatibility) 31 | - [Stonks3141](https://github.com/Stonks3141) (NixOS support) 32 | 33 | ## Contributing 34 | Requires [Whiskers](https://github.com/catppuccin/whiskers) & [Just](https://github.com/casey/just) be installed 35 | 36 | 1. Make changes to `templates/` file(s) 37 | 2. Run `just build` 38 | 3. Commit changes to branch, make PR 39 | 40 | Changes to prompt appearance require new [catwalk](https://github.com/catppuccin/catwalk) image. 41 | 42 | > [!TIP] 43 | > When making changes to the prompt, simply run `export STARSHIP_CONFIG="../../starship/starship.toml"` in your terminal for testing. Use an absolute path. This way, you don't have to worry about moving or replacing your personal starship.toml. 44 | 45 |   46 | 47 |

48 | 49 |

50 | 51 |

52 | Copyright © 2021-present Catppuccin Org 53 |

54 | 55 |

56 | 57 |

58 | -------------------------------------------------------------------------------- /assets/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/catppuccin/starship/e99ba6b210c0739af2a18094024ca0bdf4bb3225/assets/.gitkeep -------------------------------------------------------------------------------- /assets/preview.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/catppuccin/starship/e99ba6b210c0739af2a18094024ca0bdf4bb3225/assets/preview.webp -------------------------------------------------------------------------------- /justfile: -------------------------------------------------------------------------------- 1 | _default: 2 | @just --list 3 | 4 | build: 5 | whiskers templates/starship.tera 6 | whiskers templates/example.tera 7 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "local>catppuccin/renovate-config" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /starship.toml: -------------------------------------------------------------------------------- 1 | # Get editor completions based on the config schema 2 | "$schema" = 'https://starship.rs/config-schema.json' 3 | 4 | # Sets user-defined palette 5 | # Palettes must be defined _after_ this line 6 | palette = "catppuccin_macchiato" 7 | 8 | # Starship modules 9 | [character] 10 | # Note the use of Catppuccin color 'peach' 11 | success_symbol = "[[󰄛](green) ❯](peach)" 12 | error_symbol = "[[󰄛](red) ❯](peach)" 13 | vimcmd_symbol = "[󰄛 ❮](subtext1)" # For use with zsh-vi-mode 14 | 15 | [git_branch] 16 | style = "bold mauve" 17 | 18 | [directory] 19 | truncation_length = 4 20 | style = "bold lavender" 21 | 22 | # Palette definitions 23 | [palettes.catppuccin_latte] 24 | rosewater = "#dc8a78" 25 | flamingo = "#dd7878" 26 | pink = "#ea76cb" 27 | mauve = "#8839ef" 28 | red = "#d20f39" 29 | maroon = "#e64553" 30 | peach = "#fe640b" 31 | yellow = "#df8e1d" 32 | green = "#40a02b" 33 | teal = "#179299" 34 | sky = "#04a5e5" 35 | sapphire = "#209fb5" 36 | blue = "#1e66f5" 37 | lavender = "#7287fd" 38 | text = "#4c4f69" 39 | subtext1 = "#5c5f77" 40 | subtext0 = "#6c6f85" 41 | overlay2 = "#7c7f93" 42 | overlay1 = "#8c8fa1" 43 | overlay0 = "#9ca0b0" 44 | surface2 = "#acb0be" 45 | surface1 = "#bcc0cc" 46 | surface0 = "#ccd0da" 47 | base = "#eff1f5" 48 | mantle = "#e6e9ef" 49 | crust = "#dce0e8" 50 | 51 | [palettes.catppuccin_frappe] 52 | rosewater = "#f2d5cf" 53 | flamingo = "#eebebe" 54 | pink = "#f4b8e4" 55 | mauve = "#ca9ee6" 56 | red = "#e78284" 57 | maroon = "#ea999c" 58 | peach = "#ef9f76" 59 | yellow = "#e5c890" 60 | green = "#a6d189" 61 | teal = "#81c8be" 62 | sky = "#99d1db" 63 | sapphire = "#85c1dc" 64 | blue = "#8caaee" 65 | lavender = "#babbf1" 66 | text = "#c6d0f5" 67 | subtext1 = "#b5bfe2" 68 | subtext0 = "#a5adce" 69 | overlay2 = "#949cbb" 70 | overlay1 = "#838ba7" 71 | overlay0 = "#737994" 72 | surface2 = "#626880" 73 | surface1 = "#51576d" 74 | surface0 = "#414559" 75 | base = "#303446" 76 | mantle = "#292c3c" 77 | crust = "#232634" 78 | 79 | [palettes.catppuccin_macchiato] 80 | rosewater = "#f4dbd6" 81 | flamingo = "#f0c6c6" 82 | pink = "#f5bde6" 83 | mauve = "#c6a0f6" 84 | red = "#ed8796" 85 | maroon = "#ee99a0" 86 | peach = "#f5a97f" 87 | yellow = "#eed49f" 88 | green = "#a6da95" 89 | teal = "#8bd5ca" 90 | sky = "#91d7e3" 91 | sapphire = "#7dc4e4" 92 | blue = "#8aadf4" 93 | lavender = "#b7bdf8" 94 | text = "#cad3f5" 95 | subtext1 = "#b8c0e0" 96 | subtext0 = "#a5adcb" 97 | overlay2 = "#939ab7" 98 | overlay1 = "#8087a2" 99 | overlay0 = "#6e738d" 100 | surface2 = "#5b6078" 101 | surface1 = "#494d64" 102 | surface0 = "#363a4f" 103 | base = "#24273a" 104 | mantle = "#1e2030" 105 | crust = "#181926" 106 | 107 | [palettes.catppuccin_mocha] 108 | rosewater = "#f5e0dc" 109 | flamingo = "#f2cdcd" 110 | pink = "#f5c2e7" 111 | mauve = "#cba6f7" 112 | red = "#f38ba8" 113 | maroon = "#eba0ac" 114 | peach = "#fab387" 115 | yellow = "#f9e2af" 116 | green = "#a6e3a1" 117 | teal = "#94e2d5" 118 | sky = "#89dceb" 119 | sapphire = "#74c7ec" 120 | blue = "#89b4fa" 121 | lavender = "#b4befe" 122 | text = "#cdd6f4" 123 | subtext1 = "#bac2de" 124 | subtext0 = "#a6adc8" 125 | overlay2 = "#9399b2" 126 | overlay1 = "#7f849c" 127 | overlay0 = "#6c7086" 128 | surface2 = "#585b70" 129 | surface1 = "#45475a" 130 | surface0 = "#313244" 131 | base = "#1e1e2e" 132 | mantle = "#181825" 133 | crust = "#11111b" 134 | 135 | -------------------------------------------------------------------------------- /templates/example.tera: -------------------------------------------------------------------------------- 1 | --- 2 | whiskers: 3 | version: 2.5.1 4 | matrix: 5 | - flavor 6 | filename: "starship.toml" 7 | --- 8 | # Get editor completions based on the config schema 9 | "$schema" = 'https://starship.rs/config-schema.json' 10 | 11 | # Sets user-defined palette 12 | # Palettes must be defined _after_ this line 13 | palette = "catppuccin_macchiato" 14 | 15 | # Starship modules 16 | [character] 17 | # Note the use of Catppuccin color 'peach' 18 | success_symbol = "[[󰄛](green) ❯](peach)" 19 | error_symbol = "[[󰄛](red) ❯](peach)" 20 | vimcmd_symbol = "[󰄛 ❮](subtext1)" # For use with zsh-vi-mode 21 | 22 | [git_branch] 23 | style = "bold mauve" 24 | 25 | [directory] 26 | truncation_length = 4 27 | style = "bold lavender" 28 | 29 | # Palette definitions 30 | {%- for _, flavor in flavors %} 31 | {{ read_file(path="../themes/" ~ flavor.identifier ~ ".toml") }} 32 | {%- endfor %} 33 | -------------------------------------------------------------------------------- /templates/starship.tera: -------------------------------------------------------------------------------- 1 | --- 2 | whiskers: 3 | version: 2.5.1 4 | matrix: 5 | - flavor 6 | filename: "themes/{{ flavor.identifier }}.toml" 7 | --- 8 | 9 | {%- set palette = flavor.colors -%} 10 | 11 | [palettes.catppuccin_{{ flavor.identifier }}] 12 | {%- for _, color in palette %} 13 | {{ color.identifier }} = "#{{ color.hex }}" 14 | {%- endfor %} 15 | -------------------------------------------------------------------------------- /themes/frappe.toml: -------------------------------------------------------------------------------- 1 | [palettes.catppuccin_frappe] 2 | rosewater = "#f2d5cf" 3 | flamingo = "#eebebe" 4 | pink = "#f4b8e4" 5 | mauve = "#ca9ee6" 6 | red = "#e78284" 7 | maroon = "#ea999c" 8 | peach = "#ef9f76" 9 | yellow = "#e5c890" 10 | green = "#a6d189" 11 | teal = "#81c8be" 12 | sky = "#99d1db" 13 | sapphire = "#85c1dc" 14 | blue = "#8caaee" 15 | lavender = "#babbf1" 16 | text = "#c6d0f5" 17 | subtext1 = "#b5bfe2" 18 | subtext0 = "#a5adce" 19 | overlay2 = "#949cbb" 20 | overlay1 = "#838ba7" 21 | overlay0 = "#737994" 22 | surface2 = "#626880" 23 | surface1 = "#51576d" 24 | surface0 = "#414559" 25 | base = "#303446" 26 | mantle = "#292c3c" 27 | crust = "#232634" 28 | -------------------------------------------------------------------------------- /themes/latte.toml: -------------------------------------------------------------------------------- 1 | [palettes.catppuccin_latte] 2 | rosewater = "#dc8a78" 3 | flamingo = "#dd7878" 4 | pink = "#ea76cb" 5 | mauve = "#8839ef" 6 | red = "#d20f39" 7 | maroon = "#e64553" 8 | peach = "#fe640b" 9 | yellow = "#df8e1d" 10 | green = "#40a02b" 11 | teal = "#179299" 12 | sky = "#04a5e5" 13 | sapphire = "#209fb5" 14 | blue = "#1e66f5" 15 | lavender = "#7287fd" 16 | text = "#4c4f69" 17 | subtext1 = "#5c5f77" 18 | subtext0 = "#6c6f85" 19 | overlay2 = "#7c7f93" 20 | overlay1 = "#8c8fa1" 21 | overlay0 = "#9ca0b0" 22 | surface2 = "#acb0be" 23 | surface1 = "#bcc0cc" 24 | surface0 = "#ccd0da" 25 | base = "#eff1f5" 26 | mantle = "#e6e9ef" 27 | crust = "#dce0e8" 28 | -------------------------------------------------------------------------------- /themes/macchiato.toml: -------------------------------------------------------------------------------- 1 | [palettes.catppuccin_macchiato] 2 | rosewater = "#f4dbd6" 3 | flamingo = "#f0c6c6" 4 | pink = "#f5bde6" 5 | mauve = "#c6a0f6" 6 | red = "#ed8796" 7 | maroon = "#ee99a0" 8 | peach = "#f5a97f" 9 | yellow = "#eed49f" 10 | green = "#a6da95" 11 | teal = "#8bd5ca" 12 | sky = "#91d7e3" 13 | sapphire = "#7dc4e4" 14 | blue = "#8aadf4" 15 | lavender = "#b7bdf8" 16 | text = "#cad3f5" 17 | subtext1 = "#b8c0e0" 18 | subtext0 = "#a5adcb" 19 | overlay2 = "#939ab7" 20 | overlay1 = "#8087a2" 21 | overlay0 = "#6e738d" 22 | surface2 = "#5b6078" 23 | surface1 = "#494d64" 24 | surface0 = "#363a4f" 25 | base = "#24273a" 26 | mantle = "#1e2030" 27 | crust = "#181926" 28 | -------------------------------------------------------------------------------- /themes/mocha.toml: -------------------------------------------------------------------------------- 1 | [palettes.catppuccin_mocha] 2 | rosewater = "#f5e0dc" 3 | flamingo = "#f2cdcd" 4 | pink = "#f5c2e7" 5 | mauve = "#cba6f7" 6 | red = "#f38ba8" 7 | maroon = "#eba0ac" 8 | peach = "#fab387" 9 | yellow = "#f9e2af" 10 | green = "#a6e3a1" 11 | teal = "#94e2d5" 12 | sky = "#89dceb" 13 | sapphire = "#74c7ec" 14 | blue = "#89b4fa" 15 | lavender = "#b4befe" 16 | text = "#cdd6f4" 17 | subtext1 = "#bac2de" 18 | subtext0 = "#a6adc8" 19 | overlay2 = "#9399b2" 20 | overlay1 = "#7f849c" 21 | overlay0 = "#6c7086" 22 | surface2 = "#585b70" 23 | surface1 = "#45475a" 24 | surface0 = "#313244" 25 | base = "#1e1e2e" 26 | mantle = "#181825" 27 | crust = "#11111b" 28 | --------------------------------------------------------------------------------