--- home: true heroImage: /logo.svg heroText: null tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! actionText: Get Started → actionLink: ./guide/ features: - title: Compatibility First details: Works on the most common shells on the most common operating systems. Use it everywhere! - title: Rust-Powered details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible. - title: Customizable details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be. footer: ISC Licensed | Copyright © 2019-present Starship Contributors # Used for the description meta tag, for SEO metaTitle: "Starship: Cross-Shell Prompt" description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, and PowerShell. ---
### Quick Install 1. Install the **starship** binary: #### Install Latest Version With Shell: ```sh curl -fsSL https://starship.rs/install.sh | bash ``` #### Install via Package Manager With [Homebrew](https://brew.sh/): ```sh brew install starship ``` With [Scoop](https://scoop.sh): ```powershell scoop install starship ``` 1. Add the init script to your shell's config file: #### Bash Add the following to the end of `~/.bashrc`: ```sh # ~/.bashrc eval "$(starship init bash)" ``` #### Fish Add the following to the end of `~/.config/fish/config.fish`: ```sh # ~/.config/fish/config.fish starship init fish | source ``` #### Zsh Add the following to the end of `~/.zshrc`: ```sh # ~/.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. ```sh Invoke-Expression (&starship init powershell) ``` #### Ion Add the following to the end of `~/.config/ion/initrc`: ```sh # ~/.config/ion/initrc eval $(starship init ion) ```