Go to file
Thomas O'Donnell 055986e2b1
feat(python): Add option to change the python binary (#1297)
* Add option to change the python binary

We are going to start to have problems with the python binary as python2
is removed and replaced with python3. To make the transition easier I
have added an option to the python module to allow the user to pick a
particular binary, e.g `python3`, for the module to use when selecting
the version of python. I have also refactored the python tests moving
almost all of them into the module and removing the dependency on the
version of python that is installed on the system.

* Add advanced config section to python module docs

Have added an advanced config section to the python module docs and
moved the `python_binary` option into that section.
2020-06-14 11:27:10 +02:00
.github Fix security audit github action (#1256) 2020-05-25 16:04:26 +02:00
docs feat(python): Add option to change the python binary (#1297) 2020-06-14 11:27:10 +02: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 feat(python): Add option to change the python binary (#1297) 2020-06-14 11:27:10 +02:00
starship_module_config_derive docs: Replace project tagline 2020-02-12 21:46:00 -05:00
tests feat(python): Add option to change the python binary (#1297) 2020-06-14 11:27:10 +02: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 fix: possible fix for Intermittent Test Failures in GH Actions (#987) 2020-03-15 12:12:25 -05:00
Cargo.lock build(deps): bump serde_json from 1.0.53 to 1.0.54 (#1306) 2020-06-10 10:00:27 +02:00
Cargo.toml build(deps): bump serde_json from 1.0.53 to 1.0.54 (#1306) 2020-06-10 10:00:27 +02:00
LICENSE docs: update license to include 2020 (#1184) 2020-05-10 19:14:28 -04:00
README.md docs: Fix broken installation link anchor on README (#1033) 2020-04-20 12:43:24 -05: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 ~\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.