Go to file
David Hewson 178f177dac perf(hg_branch): Replace direct calls to `hg` (#803)
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
2020-01-03 17:51:45 -05:00
.github build: Bump checkout action from v1 to v2 (#789) 2019-12-28 09:32:17 -05:00
docs feat(git_status): Add a stash count segment (#598) 2019-12-28 22:20:36 -05:00
install fix: Fix shellcheck issues in install.sh (#714) 2019-12-20 10:54:40 -05:00
media docs(i18n): Update Crowdin translations (#517) 2019-10-21 23:42:08 +09:00
src perf(hg_branch): Replace direct calls to `hg` (#803) 2020-01-03 17:51:45 -05:00
starship_module_config_derive refactor: ModuleConfig: Simplify generated `from_config()` implementations (#775) 2019-12-23 10:12:21 -05:00
tests perf(hg_branch): Replace direct calls to `hg` (#803) 2020-01-03 17:51:45 -05:00
.all-contributorsrc docs: add marblenix as a contributor (#791) 2019-12-28 22:21:57 -05:00
.dockerignore Add docker for integration tests (#37) 2019-04-28 13:34:46 -04:00
.gitignore chore: Cleanup after the config refactor (#453) 2019-09-30 23:56:05 +09:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#42) 2019-04-30 23:30:42 -04:00
CONTRIBUTING.md docs: Add docs for running the starship website locally (#552) 2019-10-18 23:00:38 +09:00
Cargo.lock feat: Add the `starship explain` command (#699) 2020-01-01 23:19:08 -05:00
Cargo.toml feat: Add the `starship explain` command (#699) 2020-01-01 23:19:08 -05:00
LICENSE docs: Attribute copyright to Starship Contributors (#115) 2019-07-25 12:50:29 -04:00
README.md docs: add marblenix as a contributor (#791) 2019-12-28 22:21:57 -05:00
acceptance_test chore: Rename integration_test to acceptance_test (#356) 2019-09-12 18:01:13 -05:00
crowdin.yml docs: Fix link to Japanese README 2019-10-11 17:32:52 +09:00
snapcraft.yaml chore: Move snapcraft.yaml to project root 2019-12-11 11:44:52 -05:00

README.md


Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord All Contributors


Website · Installation · Configuration

English   日本語   繁體中文   简体中文   Deutsch   Français   Русский

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

Getting Started

  1. Install the starship binary:

    Install Latest Version

    With Shell:
    curl -fsSL https://starship.rs/install.sh | bash
    

    Install via Package Manager

    With Homebrew:
    brew install starship
    
    With Scoop:
    scoop install starship
    
  2. 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 | source
    

    Zsh

    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.ps1 on -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):


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

💻 ⚠️ 👀

Quinn Strahl

💻 ⚠️

Titouan Vervack

💻 ⚠️

Francisco Lopes

💻

Andrew Houts

💻 📖 ⚠️

Nick Young

💻 📖 ⚠️ 👀

Gabriel de Perthuis

💻

Hofer-Julian

📖

Yuji Ueki

🖋 🌍

谢祯晖

💻 📖 🌍 👀

Kutsuzawa Ryo

👀 💻 ⚠️ 🌍

hdevalke

🤔

Kuba Clark

💻 📖 ⚠️

Gimbar

💻 ⚠️ 📖

Tom Hotston

💻 📖

Bijan Chokoufe Nejad

💻 ⚠️ 👀

yuri

💻 📖 ⚠️

TsubasaKawajiri

🌍

Ryo Yamashita

💻

Thomas Lee

💻

(´⌣`ʃƪ)

💻

Barnaby Keene

💻

Keith Wade

💻 ⚠️

LukeAI

📖

Zach Mertes

💻 📖 ⚠️

David Knaack

💻 📖 ⚠️

Carl Summers

📖

Yushan Lin

🌍

Weihang Lo

🌍

pinshan

🌍

Brian Low

💻 📖 ⚠️

Matias Kotlik

💻

marblenix

🚇 💻 ⚠️

Raidou

💻 ⚠️

Luca Greco

💻 📖 ⚠️

Luca Rinaldi

💻

Stephen Ball

💻 ⚠️ 📖

Qingping Hou

💻 📖 ⚠️

Dan Wendorf

💻 ⚠️

Alan Pope

🚇

BuggStream

💻 📖

Jon Grythe Stødle

💻 ⚠️

Jason Etcovitch

🐛

Etienne Mabille

💻

AppleTheGolden

💻 📖

Mike Sampson

💻 📖 ⚠️

Dominik Braun

💻

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


Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.