Go to file
SeongChan Lee 611a754ec7
fix(directory): Fix path contractions for symlinked git repos (#1299)
Fixes git repo path contractions in two situations:

1. When path obtained from `PWD` is a logical path but git libraries
   return physical paths.
2. When a git repository's subdirectory is symlinked to ouside of the
   repository tree.

(1) is fixed by implementing a realpath()-like function, then reparsing
the (possibly logical) `PWD` using realpath() to convert logical
components into physical ones. The physical paths are then matched
against each other.

In the case of (2), the default behavior has been changed by simply
contracting to the home directory, exactly the same as if we are not in
a repo at all. Because determining the correct contraction is not
obvious, we bail out and just pretend we are not in a repo at all.
2020-06-17 22:44:51 -05:00
.github Fix security audit github action (#1256) 2020-05-25 16:04:26 +02:00
docs style(docs): remove `$` prefix from shell snippets (#1339) 2020-06-17 07:31:24 -05: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(directory): Fix path contractions for symlinked git repos (#1299) 2020-06-17 22:44:51 -05:00
starship_module_config_derive docs: Replace project tagline 2020-02-12 21:46:00 -05:00
tests fix(directory): Fix path contractions for symlinked git repos (#1299) 2020-06-17 22:44:51 -05: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: remove redundant settings in Contributing guide (#1326) 2020-06-14 16:02:24 -04:00
Cargo.lock build(deps): bump serde_json from 1.0.54 to 1.0.55 (#1331) 2020-06-15 18:48:25 +02:00
Cargo.toml build(deps): bump serde_json from 1.0.54 to 1.0.55 (#1331) 2020-06-15 18:48:25 +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.