1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-24 21:57:41 +00:00
The minimal, blazing-fast, and infinitely customizable prompt for any shell!
Go to file
Thomas O'Donnell 3cc7a6d6ac
Use the default version of python in CI (#1449)
This removes the hard requirement for a particular version of python in
the CI, and just uses the default version. Since #1297 was merged we
have not depended on the version of python that is installed. This
should stop us from having to update the version of python when the
github action updates the available versions.
2020-07-07 14:31:02 +02:00
.github Use the default version of python in CI (#1449) 2020-07-07 14:31:02 +02:00
docs docs: update font in FAQ from Fira Code → FiraCode Nerd Font 2020-07-06 19:00:42 -04:00
install fix: errant space breaks tar in installer (#1314) 2020-06-11 13:12:14 -05:00
media chore(bump): v0.35.0 2020-02-06 09:56:39 -05:00
src fix!: remove haskell module (#1418) 2020-07-06 13:00:52 -04:00
starship_module_config_derive docs: Replace project tagline 2020-02-12 21:46:00 -05:00
tests feat: git branch: read from HEAD on newly initialized repo (#1336) 2020-07-05 13:22:14 -04:00
.gitignore chore: Cleanup after the config refactor (#453) 2019-09-30 23:56:05 +09:00
Cargo.lock chore(release): v0.44.0 2020-07-06 13:09:49 -04:00
Cargo.toml chore(release): v0.44.0 2020-07-06 13:09:49 -04:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#42) 2019-04-30 23:30:42 -04:00
CONTRIBUTING.md docs: remove redundant settings in Contributing guide (#1326) 2020-06-14 16:02:24 -04:00
crowdin.yml docs: Fix link to Japanese README 2019-10-11 17:32:52 +09:00
LICENSE docs: update license to include 2020 (#1184) 2020-05-10 19:14:28 -04:00
README.md docs: fix broken contribute link on starship.rs (#1398) 2020-06-26 16:59:41 -04:00
snapcraft.yaml fix: snap build failure (#1177) 2020-05-06 20:29:09 -04:00

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 ~\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.