![]() Have added so additional spaces around the vuepress markers, `:::`, to ensure that the don't get included in the line above and below and cause formatting errors in the translated versions of the documentation. |
||
---|---|---|
.. | ||
.vuepress | ||
advanced-config | ||
ar-SA | ||
ckb-IR | ||
config | ||
de-DE | ||
es-ES | ||
faq | ||
fr-FR | ||
guide | ||
id-ID | ||
installing | ||
it-IT | ||
ja-JP | ||
ko-KR | ||
migrating-to-0.45.0 | ||
nl-NL | ||
pl-PL | ||
presets | ||
pt-BR | ||
pt-PT | ||
ru-RU | ||
tr-TR | ||
vi-VN | ||
zh-CN | ||
zh-TW | ||
package-lock.json | ||
package.json | ||
README.md |
home | heroImage | heroText | tagline | actionText | actionLink | features | footer | metaTitle | description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
true | /logo.svg | null | The minimal, blazing-fast, and infinitely customizable prompt for any shell! | Get Started → | ./guide/ |
|
ISC Licensed | Copyright © 2019-present Starship Contributors | Starship: Cross-Shell Prompt | 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, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell. |
Prerequisites
- A Nerd Font installed and enabled in your terminal.
Quick Install
-
Install the starship binary:
Install Latest Version
With Shell:
curl -sS https://starship.rs/install.sh | sh
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration.
Install via Package Manager
With Homebrew:
brew install starship
With Scoop:
scoop install starship
-
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.18 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`
Nushell
::: warning
This will change in the future. Only Nushell v0.60+ is supported.
:::
Run the following:
mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu
And add the following to the end of your Nushell configuration (find it by running
$nu.config-path
):mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
Xonsh
Add the following to the end of
~/.xonshrc
:# ~/.xonshrc execx($(starship init xonsh))
Cmd
You need to use Clink (v1.2.30+) with Cmd. Add the following to a file
starship.lua
and place this file in Clink scripts directory:-- starship.lua load(io.popen('starship init cmd'):read("*a"))()