mirror of
https://github.com/starship/starship
synced 2024-09-06 00:09:26 +00:00
.github | ||
ci | ||
docs | ||
media | ||
src | ||
tests | ||
.all-contributorsrc | ||
.dockerignore | ||
.gitignore | ||
azure-pipelines.yml | ||
Cargo.lock | ||
Cargo.toml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
integration_test | ||
LICENSE | ||
README.md |
Website · Installation · Configuration
Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! The prompt shows information need while you're working, while staying sleek and out of the way.
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 Python version (
🐍
). - Current Go version (
🐹
). - Package version of package in current directory (
📦
). - 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
- PLANNED #80 – Indicator for jobs in the background (
✦
). - PLANNED #104 – Execution time of the last command if it exceeds the set threshold.
Installation
Prerequisites
- Rust v1.33 or higher
- A Powerline font installed and enabled in your terminal (for example, try Fira Code).
Getting Started
-
Install the starship binary:
cargo install starship
-
Add the init script to your shell's config file:
Bash / Zsh
Add the following to the end of
~/.bashrc
or~/.zshrc
:# ~/.bashrc or ~/.zshrc eval "$(starship init $0)"
Fish
Add the following to the end of
~/.config/fish/config.fish
:# ~/.config/fish/config.fish eval (starship init fish)
Configuration
For details on how to configure Starship, check out our documentation.
Contribution
If you are interested in helping contribute to starship, please take a look at our Contributing Guide.
Thanks goes to these wonderful people (emoji key):
Matan Kushner 💻 🎨 🤔 🚇 🚧 👀 ⚠️ |
John Letey 💻 🤔 👀 ⚠️ |
Tim Mulqueen 💻 🤔 👀 ⚠️ |
Tiffany Le-Nguyen 🤔 🚧 👀 📖 |
Snuggle 🎨 🤔 🚧 👀 |
Ryan Leckey 👀 |
Youssef Habri 💻 |
Kevin Song 🐛 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!
License
Copyright © 2019-present, Matan Kushner