starship

mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-04 20:37:56 +00:00

The minimal, blazing-fast, and infinitely customizable prompt for any shell!

Go to file

Harry Mills 9918dd1aac docs: Correct a copy/paste error in the docs (#259 )		2019-08-29 12:41:09 -04:00
.github	chore: Add labels to issue templates	2019-08-19 13:00:32 -04:00
ci	ci: Remove brew bump formula from CI	2019-08-13 19:41:42 -04:00
docs	docs: Correct a copy/paste error in the docs (#259 )	2019-08-29 12:41:09 -04:00
media	docs: Add new demo gif to README (#231 )	2019-08-22 20:03:45 -04:00
src	Fix typo in comment (#260 )	2019-08-29 12:40:25 -04:00
tests	feat: Add commit count for ahead/behind symbols (#247 )	2019-08-27 20:11:42 -07:00
.all-contributorsrc	docs: add wyze as a contributor (#245 )	2019-08-26 22:29:32 -04:00
.dockerignore	Add docker for integration tests (#37 )	2019-04-28 13:34:46 -04:00
.gitignore	feat: Add option to control git directory truncation (#165 )	2019-08-16 20:29:22 -07:00
azure-pipelines.yml	ci: Remove remaining reference to bump brew formula	2019-08-13 19:42:25 -04:00
Cargo.lock	chore(bump): v0.13.1	2019-08-27 14:10:48 -04:00
Cargo.toml	chore(bump): v0.13.1	2019-08-27 14:10:48 -04:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md (#42 )	2019-04-30 23:30:42 -04:00
CONTRIBUTING.md	fix: Failing Tests if home is a git directory (#214 )	2019-08-21 09:37:43 -07:00
integration_test	Add support for prompt configuration (#62 )	2019-06-10 15:56:17 +01:00
LICENSE	docs: Attribute copyright to Starship Contributors (#115 )	2019-07-25 12:50:29 -04:00
README.md	Add repology badge to README (#249 )	2019-08-27 22:36:43 -07:00

README.md

Website · Installation · Configuration

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
The prompt shows information you need while you're working, while staying sleek and out of the way.

Starship with iTerm2 and the Snazzy theme

🍬 Features

Prompt character turns red if the last command exits with non-zero code
Current username if not the same as the logged-in user
Current Node.js version(⬢)
Current Rust version (🦀)
Current Ruby version (💎)
Current Python version (🐍)
Current Go version (🐹)
Nix-shell environment detection
Current version of package in current directory (📦)
- npm (Node.js)
- cargo (Rust)
- poetry (Python)
Current battery level and status
Current Git branch and rich repo status:
- = — conflicting changes
- ⇡ — ahead of remote branch
- ⇣ — behind of remote branch
- ⇕ — diverged changes
- ? — untracked changes
- $ — stashed changes
- ! — modified files
- + — added files
- » — renamed files
- ✘ — deleted files
Execution time of the last command if it exceeds the set threshold
Indicator for jobs in the background (✦)

🚀 Installation

Prerequisites

A Powerline font installed and enabled in your terminal (for example, try Fira Code).

Getting Started

Install the starship binary:

Download archives of precompiled binaries if you don't use the platforms below.

Homebrew
```
$ brew install starship
```
Rust (v1.33 or higher)
```
$ cargo install starship
```
Arch Linux (AUR)

Starship is available on the AUR under the name starship. Install it with yay or your favorite AUR helper.
```
$ yay -S starship
```
Nix (unstable)
```
$ nix-env --install starship
```
Termux
```
$ pkg install starship
```
Add the init script to your shell's config file:

Bash

Add the following to the end of ~/.bashrc:
```
# ~/.bashrc

eval "$(starship init bash)"
```
Fish

Add the following to the end of ~/.config/fish/config.fish:
```
# ~/.config/fish/config.fish

eval (starship init fish)
```
Zsh

Add the following to the end of ~/.zshrc:
```
# ~/.zshrc

eval "$(starship init zsh)"
```

🔧 Configuration

For details on how to configure Starship, check out our documentation.

🤝 Contributing

We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a good first issue.

High Priority Needs

👩‍💼 Product Manager
- We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction!
👩‍🎨 Designer
- Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas!
👩‍💻 Rust Developer
- There is a lot of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I (@matchai) am a beginner to Rust. Come point us in the right direction!

If you are interested in helping contribute to starship, please take a look at our Contributing Guide. Also, feel free to drop into our Discord server and say hi. 👋

Contributors

Thanks goes to these wonderful people (emoji key):

_{Matan Kushner} 💻 🎨 🤔 🚇 🚧 👀 ⚠️	_{John Letey} 💻 🤔 👀 ⚠️	_{Tim Mulqueen} 💻 🤔 👀 ⚠️	_{Tiffany Le-Nguyen} 🤔 🚧 👀 📖	_Snuggle 🎨 🤔 🚧 👀	_{Ryan Leckey} 👀	_{Youssef Habri} 💻
_{Kevin Song} 🐛 💻 📖 ⚠️	_{Andrew Dassonville} 🐛 💻	_MaT1g3R 💻 📖 ⚠️	_{André Zanellato} 💻 📖 ⚠️	_{Saghm Rossi} 💻 📖 ⚠️	_{Shu Kutsuzawa} 💻 📖 ⚠️	_{Saurav Sharma} 💻 📖
_{Thomas O'Donnell} 💻 ⚠️	_{Bruno Bigras} 💻	_{Neil Kistner} 💻 ⚠️