Go to file
Kevin Song 0965667807
ci: Use `dprint` to format documentation + TOML files (#3426)
Adds Rust-based standardized markdown formatting and a CI step to catch unformatted files.
2022-01-20 11:32:09 +03:00
.cargo ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
.github ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
docs ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
install feat: add support for cmd (#3277) 2022-01-09 23:47:53 -06:00
media chore: rename flag-in.png → flag-id.png 2021-12-21 12:32:48 +03:00
src feat(pwsh): Set STARSHIP_SHELL to pwsh on PS >5 (#3443) 2022-01-16 20:28:26 +01:00
starship_module_config_derive ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
.dprint.json ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03: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
CODE_OF_CONDUCT.md ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
CONTRIBUTING.md ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
Cargo.lock build: bump clap from 3.0.9 to 3.0.10 (#3463) 2022-01-19 02:05:19 -05:00
Cargo.toml ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
Cross.toml build: add x86_64 freebsd build (#2233) 2021-01-30 12:50:38 +01:00
LICENSE docs: update license to include 2021 (#2207) 2021-01-26 22:43:20 +01:00
README.md ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
build.rs build: Add additional build information to version and bug report (#2124) 2021-01-22 20:14:51 +01:00
clippy.toml ci: Use `dprint` to format documentation + TOML files (#3426) 2022-01-20 11:32:09 +03:00
crowdin.yml chore: update Crowdin PR title 2021-01-29 16:53:32 -05:00
snapcraft.yaml feat: add support for xonsh (#2807) 2021-07-16 15:25:01 -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   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

Step 1. Install Starship

Select your operating system from the list below to view installation instructions:

Android

Install Starship using any of the following package managers:

Repository Instructions
Termux pkg install starship
BSD

Install Starship using any of the following package managers:

Distribution Repository Instructions
Any crates.io cargo install starship --locked
FreeBSD FreshPorts pkg install starship
NetBSD pkgsrc pkgin install starship
Linux

Install the latest version for your system:

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

Alternatively, install Starship using any of the following package managers:

Distribution Repository Instructions
Any crates.io cargo install starship --locked
Any conda-forge conda install -c conda-forge starship
Any Linuxbrew brew install starship
Alpine Linux 3.13+ Alpine Linux Packages apk add starship
Arch Linux Arch Linux Community pacman -S starship
CentOS 7+ Copr dnf copr enable atim/starship
dnf install starship
Fedora 31+ Fedora Packages dnf install starship
NixOS nixpkgs nix-env -iA nixos.starship
Gentoo Gentoo Packages emerge app-shells/starship
Manjaro pacman -S starship
NixOS nixpkgs nix-env -iA nixpkgs.starship
Void Linux Void Linux Packages xbps-install -S starship
macOS

Install the latest version for your system:

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

Alternatively, install Starship using any of the following package managers:

Repository Instructions
crates.io cargo install starship --locked
conda-forge conda install -c conda-forge starship
Homebrew brew install starship
MacPorts port install starship
Windows

Install Starship using any of the following package managers:

Repository Instructions
crates.io cargo install starship --locked
Chocolatey choco install starship
conda-forge conda install -c conda-forge starship
Scoop scoop install starship

Step 2. Setup your shell to use Starship

Configure your shell to initialize starship. Select yours from the list below:

Bash

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

eval "$(starship init bash)"
Cmd

You need to use Clink (v1.2.30+) with Cmd. Create a file at this path %LocalAppData%\clink\starship.lua with the following contents:

load(io.popen('starship init cmd'):read("*a"))()
Elvish

Add the following to the end of ~/.elvish/rc.elv:

eval (starship init elvish)

Note: Only Elvish v0.17+ is supported

Fish

Add the following to the end of ~/.config/fish/config.fish:

starship init fish | source
Ion

Add the following to the end of ~/.config/ion/initrc:

eval $(starship init ion)
Nushell

Add the following to the end of your Nushell configuration (find it by running config path):

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

Add the following to the end of your PowerShell configuration (find it by running $PROFILE):

Invoke-Expression (&starship init powershell)
Tcsh

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

eval `starship init tcsh`
Xonsh

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

execx($(starship init xonsh))
Zsh

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

eval "$(starship init zsh)"

Step 3. Configure Starship

Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy!

If you're looking to further customize Starship:

  • Configuration learn how to configure Starship to tweak your prompt to your liking

  • Presets get inspired by the pre-built configuration of others

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