178f177dac
perf: don't use hg process to get branch / bookmark information, each call was taking 250ms and it was making on average 2 calls. the branch and bookmark information is available in files in the root of the repo, use that instead. now takes 300 micro seconds fix: do not use .hgignore to decide if it is an hg repo. was providing false positives. #721 fix: after changing branch the new branch was not show (the old branch was shown), the new branch is now correctly shown. #722 fix: if no branch override was set it would say (no branch) however if you commited in that state you would commit to the branch default so say that instead |
||
|---|---|---|
| .github | ||
| docs | ||
| install | ||
| media | ||
| src | ||
| starship_module_config_derive | ||
| tests | ||
| .all-contributorsrc | ||
| .dockerignore | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| acceptance_test | ||
| crowdin.yml | ||
| snapcraft.yaml | ||
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.
🍬 Features
- Prompt character turns red if the last command exits with non-zero code
- Current Go version (
🐹) - Current Java version(
☕) - Current Node.js version(
⬢) - Current PHP version (
🐘) - Current Python version (
🐍) - Current Ruby version (
💎) - Current Rust version (
🦀) - Current .NET version (
•NET) - Current version of package in current directory (
📦)- npm (Node.js)
- cargo (Rust)
- poetry (Python)
- composer (PHP)
- 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
- Current Mercurial branch
- Current battery level and status
⇡– charging⇣– discharging•– fully charged- Indicator for jobs in the background (
✦) - Current Kubernetes Cluster and Namespace (
☸) - Current Amazon Web Services (AWS) profile (
☁️) - Execution time of the last command
- Custom environment variable value
- Nix-shell environment detection
- Current username if not the same as the logged-in user
- Optional current time in 12/24hr format
🚀 Installation
Prerequisites
- A Powerline font installed and enabled in your terminal (for example, try Fira Code).
Getting Started
-
Install the starship binary:
Install Latest Version
With Shell:
curl -fsSL https://starship.rs/install.sh | bashInstall via Package Manager
With Homebrew:
brew install starshipWith Scoop:
scoop 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 starship init fish | sourceZsh
Add the following to the end of
~/.zshrc:# ~/.zshrc eval "$(starship init zsh)"PowerShell
Add the following to the end of
~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1(or~/.config/powershell/Microsoft.PowerShell_profile.ps1on -Nix):# ~\Documents\PowerShell\Profile.ps1 Invoke-Expression (&starship init powershell)Ion
Add the following to the end of
~/.config/ion/initrc:# ~/.config/ion/initrc eval $(starship init ion)
🔧 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):
This project follows the all-contributors specification. Contributions of any kind welcome!
💭 Inspired By
Please check out these previous works that helped inspire the creation of starship. 🙏
-
denysdovhan/spaceship-prompt - A ZSH prompt for astronauts.
-
denysdovhan/robbyrussell-node - Cross-shell robbyrussell theme written in JavaScript.
-
reujab/silver - A cross-shell customizable powerline-like prompt with icons.
📝 License
Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.