Go to file
Gabriel de Perthuis 3dfe4ca932
fix(git_state): Handle gitdir indirection when rebasing (#1744)
* Make git_state more robust

No need to come up with fake progress info.

See #1374, #1761.

* git_state: add support for .git indirection when rebasing
2020-11-26 19:56:18 +01:00
.github ci: Run against nightly version of rust (#1814) 2020-10-21 09:17:54 +02:00
docs feat(git_branch): add remote branch name if different than local branch (#1915) 2020-11-23 22:07:16 +01:00
install fix(install): Better platform detection (#1827) 2020-10-25 10:16:47 +01:00
media chore(bump): v0.35.0 2020-02-06 09:56:39 -05:00
src fix(git_state): Handle gitdir indirection when rebasing (#1744) 2020-11-26 19:56:18 +01:00
starship_module_config_derive chore(release): release starship_module_config_derive v0.1.2 2020-09-30 16:13:42 -04:00
.gitignore feat(package): Add Maven pom.xml version support (#1511) 2020-07-31 09:54:03 +02:00
.rustfmt.toml style: make rustfmt use the default configuration (#1661) 2020-09-19 08:45:17 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#42) 2019-04-30 23:30:42 -04:00
CONTRIBUTING.md docs: fix typo in CONTRIBUTING.md (#1772) 2020-10-13 12:08:32 -04:00
Cargo.lock build(deps): bump unicode-segmentation from 1.7.0 to 1.7.1 2020-11-25 09:55:02 +00:00
Cargo.toml build(deps): bump unicode-segmentation from 1.7.0 to 1.7.1 2020-11-25 09:55:02 +00:00
LICENSE docs: update license to include 2020 (#1184) 2020-05-10 19:14:28 -04:00
README.md docs(pwsh/init): various fixes for init doc (#1793) 2020-11-03 18:52:46 +01:00
crowdin.yml docs: Fix link to Japanese README 2019-10-11 17:32:52 +09:00
snapcraft.yaml fix: snap build failure (#1177) 2020-05-06 20:29:09 -04:00

README.md

Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord Follow @StarshipPrompt on Twitter

Website · Installation · Configuration

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

Starship with iTerm2 and the Snazzy theme

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

  • Fast: it's fast really really fast! 🚀
  • Customizable: configure every aspect of your prompt.
  • Universal: works on any shell, on any operating system.
  • Intelligent: shows relevant information at a glance.
  • Feature rich: support for all your favorite tools.
  • Easy: quick to install  start using it in minutes.

Explore the Starship docs  ▶

🚀 Installation

Prerequisites

Getting Started

  1. Install the starship binary:

    Install Latest Version

    From prebuilt binary, with Shell:
    curl -fsSL https://starship.rs/install.sh | bash
    
    From source on crates.io:
    cargo install starship
    

    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 Microsoft.PowerShell_profile.ps1. You can check the location of this file by querying the $PROFILE variable in PowerShell. Typically the path is ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 or ~/.config/powershell/Microsoft.PowerShell_profile.ps1 on -Nix.

    Invoke-Expression (&starship init powershell)
    

    Ion

    Add the following to the end of ~/.config/ion/initrc:

    # ~/.config/ion/initrc
    
    eval $(starship init ion)
    

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

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

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

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