🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
Go to file
dependabot[bot] 2d666fb32f
build: bump clap from 3.0.4 to 3.0.5 (#3398)
Bumps [clap](https://github.com/clap-rs/clap) from 3.0.4 to 3.0.5.
- [Release notes](https://github.com/clap-rs/clap/releases)
- [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md)
- [Commits](https://github.com/clap-rs/clap/compare/v3.0.4...v3.0.5)

---
updated-dependencies:
- dependency-name: clap
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-01-06 10:05:46 +03:00
.cargo chore(audit): unignore RUSTSEC-2020-0095 (difference is unmaintained) (#3319) 2021-12-13 20:36:43 +01:00
.github docs: Update GitHub ISSUE_TEMPLATE (#3366) 2021-12-31 04:06:34 -05:00
docs feat(package): support for dart pub version (#3373) 2022-01-01 23:57:20 +01:00
install fix(elvish): upgrade shell integration for v0.17 (#3310) 2021-12-30 09:49:55 +01:00
media chore: rename flag-in.png → flag-id.png 2021-12-21 12:32:48 +03:00
src refactor: update clap to v3 (#3370) 2022-01-04 12:49:42 +03:00
starship_module_config_derive chore: upgrade to edition 2021 (#3171) 2021-10-25 13:39:09 -04:00
.gitattributes fix: init script line endings (#3178) 2021-10-30 10:51:56 +02: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
build.rs build: Add additional build information to version and bug report (#2124) 2021-01-22 20:14:51 +01:00
Cargo.lock build: bump clap from 3.0.4 to 3.0.5 (#3398) 2022-01-06 10:05:46 +03:00
Cargo.toml build: bump clap from 3.0.4 to 3.0.5 (#3398) 2022-01-06 10:05:46 +03:00
clippy.toml chore: hide warnings for additional known advisories (#3170) 2021-10-21 17:35:08 -04:00
CODE_OF_CONDUCT.md Update to Contributor Covenant v2.0 2021-04-14 17:47:08 -04:00
CONTRIBUTING.md docs: add a checklist for new modules (#3076) 2021-10-05 06:16:19 -04:00
Cross.toml build: add x86_64 freebsd build (#2233) 2021-01-30 12:50:38 +01:00
crowdin.yml chore: update Crowdin PR title 2021-01-29 16:53:32 -05:00
LICENSE docs: update license to include 2021 (#2207) 2021-01-26 22:43:20 +01:00
README.md fix(elvish): upgrade shell integration for v0.17 (#3310) 2021-12-30 09:49:55 +01:00
snapcraft.yaml feat: add support for xonsh (#2807) 2021-07-16 15:25:01 -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   Bahasa Indonesia   Italiano   日本語   Português do Brasil   Русский   Tiếng Việt   简体中文   繁體中文

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

Note: due to the proliferation of different platforms, only a subset of supported platforms are shown below. Can't see yours? Have a look at the extra platform instructions.

  1. Install the starship binary:

    Install Latest Version

    From prebuilt binary, with Shell:
    sh -c "$(curl -fsSL https://starship.rs/install.sh)"
    

    To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.

    Note - The defaults of the install script can be overridden see the built-in help.

    sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --help
    

    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)
    

    Elvish

    Warning Only elvish v0.17 or higher is supported. Add the following to the end of ~/.elvish/rc.elv:

    # ~/.elvish/rc.elv
    
    eval (starship init elvish)
    

    Tcsh

    Add the following to the end of ~/.tcshrc:

    # ~/.tcshrc
    
    eval `starship init tcsh`
    

    Xonsh

    Add the following to the end of ~/.xonshrc:

    # ~/.xonshrc
    
    execx($(starship init xonsh))
    

    Nushell

    Warning This will change in the future. Only nu version v0.33 or higher is supported. Add the following to your nu config file. You can check the location of this file by running config path in nu.

    startup = [
     "mkdir ~/.cache/starship",
     "starship init nu | save ~/.cache/starship/init.nu",
     "source ~/.cache/starship/init.nu"
    ]
    prompt = "starship_prompt"
    

🤝 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 fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the Starship Crowdin.

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

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