BasixKOR / starship

โ˜„๐ŸŒŒ๏ธ The minimal, blazing-fast, and infinitely customizable prompt for any shell!

Home Page:https://starship.rs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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. ๐Ÿ‘‹

๐Ÿ’ญ 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.

About

โ˜„๐ŸŒŒ๏ธ The minimal, blazing-fast, and infinitely customizable prompt for any shell!

https://starship.rs

License:ISC License


Languages

Language:Rust 96.1%Language:Shell 3.6%Language:PowerShell 0.2%