https://github.com/catppuccin/starship

🚀 Soothing pastel theme for Starship
https://github.com/catppuccin/starship

catppuccin hacktoberfest starship theme

Last synced: 3 months ago
JSON representation

🚀 Soothing pastel theme for Starship

• Host: GitHub
• URL: https://github.com/catppuccin/starship
• Owner: catppuccin
• License: mit
• Created: 2023-02-14T19:31:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-07T03:25:56.000Z (11 months ago)
• Last Synced: 2024-12-07T04:20:14.159Z (11 months ago)
• Topics: catppuccin, hacktoberfest, starship, theme
• Language: Just
• Homepage:
• Size: 286 KB
• Stars: 233
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


	


	

	Catppuccin for Starship

	





	

	

	





	



## Usage

1. Copy one or all of the flavor palettes from [`themes/`](./themes/) to your [Starship configuration file](https://starship.rs/config/).

2. Set `palette = "catppuccin_"`, preferably at the top of your config. Palette tables must be defined under this line.

3. Save and reload your prompt.

> [!TIP]

> Check out this [example Starship configuration](starship.toml) for how to define and use colors from custom palettes.

> [!NOTE]

> Looking for inspiration or ready-made presets? Visit the [Show & Tell discussions](https://github.com/catppuccin/starship/discussions/categories/show-and-tell) to browse and share community-made themes!

## 💝 Thanks to

- [bexli](https://github.com/joshpaulie) ("Maintainer")

- [uncenter](https://github.com/uncenter) (Catppuccin Whiskers Compatibility)

- [Stonks3141](https://github.com/Stonks3141) (NixOS support)

## Contributing

Requires [Whiskers](https://github.com/catppuccin/whiskers) & [Just](https://github.com/casey/just) be installed

1. Make changes to `templates/` file(s)

2. Run `just build`

3. Commit changes to branch, make PR

Changes to prompt appearance require new [catwalk](https://github.com/catppuccin/catwalk) image.

> [!TIP]

> 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.

 



	





	Copyright © 2021-present Catppuccin Org