:rocket::star: Minimalistic, powerful and extremely customizable Zsh prompt
Zsh
prompt
Spaceship is a minimalistic, powerful and extremely customizable Zsh prompt. Prompt is what you see when you type a command. It can show a lot of useful tips, saving your time and making user experience smooth and pleasant. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.
Visit Frequently Asked Question for similar setup and find more examples with different color schemes in Screenshots wiki-page.
Here are some sneak picks of what Spaceship can show:
✦
Want more features? Please, open an issue or send pull request.
Before we begin, let's make sure you have the following installed:
echo $ZSH_VERSION #> 5.8.1
echo -e "\xee\x82\xa0" #>
Here's a few popular methods to install Spaceship. Select the one you use from the list below:
brew install spaceship
Add prompt initialization to your .zshrc
:
echo "source $(brew --prefix)/opt/spaceship/spaceship.zsh" >>! ~/.zshrc
git clone https://github.com/spaceship-prompt/spaceship-prompt.git "$ZSH_CUSTOM/themes/spaceship-prompt" --depth=1
Symlink spaceship.zsh-theme
to your oh-my-zsh custom themes directory:
ln -s "$ZSH_CUSTOM/themes/spaceship-prompt/spaceship.zsh-theme" "$ZSH_CUSTOM/themes/spaceship.zsh-theme"
Set ZSH_THEME="spaceship"
in your .zshrc
.
npm install -g spaceship-prompt
This command will download Spaceship. It will also ask you to source Spaceship in your ~/.zshrc
file.
prezto-contrib
to the proper location.contrib-prompt
module (before the prompt
module).zstyle ':prezto:module:prompt' theme 'spaceship'
in your .zpreztorc
.zmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules
Then install Spaceship:
zimfw install
antigen theme spaceship-prompt/spaceship-prompt
antibody bundle spaceship-prompt/spaceship-prompt
zinit light spaceship-prompt/spaceship-prompt
zgen load spaceship-prompt/spaceship-prompt spaceship
zplug "spaceship-prompt/spaceship-prompt", use:spaceship.zsh, from:github, as:theme
[plugins.spaceship]
github = "spaceship-prompt/spaceship-prompt"
Or run the following to automatically add it:
sheldon add spaceship --github spaceship-prompt/spaceship-prompt
Install the latest release from the AUR package spaceship-prompt:
git clone https://aur.archlinux.org/spaceship-prompt.git
cd spaceship-prompt
makepkg -si
or using yay
:
yay -S spaceship-prompt
Also there is an unmaintained git package spaceship-prompt-git.
If none of the above methods works for you, you can install Spaceship manually.
$HOME/.zsh/spaceship
.~/.zshrc
.mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-prompt.git "$HOME/.zsh/spaceship"
For initializing prompt system add this to your .zshrc
:
source "$HOME/.zsh/spaceship/spaceship.zsh"
Spaceship works well out of the box, but you can customize almost everything if you want.
Additionally, join our community in Discord and follow our Twitter for updates.
We're glad to accept contributions from developers of all skill levels! If you are interested in contributing to Spaceship, please take a look at our Contribution Guide for more details. If you're looking for an easy way into the project, take one of the issues with good first issue label.
If you are fluent in any other language besides English, we greatly appreciate any help with translating our documentation in other languages. If you would like to help, join the team of translators on our Crowdin.
If you're interested in helping other people, answer questions asked by other users of Spaceship and help to solve their issues. Additionally, join our Discord to discuss Spaceship and help people who need help.
If you really enjoy this project, you can contribute financially. Any contribution is highly appreciated, even the smallest one. There are several ways to donate:
0x5C9496De5E51D48daf28354DC04d8f9D33955559
bc1q5ezjvpgftmx42f9qgdf5lscjz43uh4jf02uvje
Find answers on our troubleshooting page or get help by our community.
Issues • Discussions • Discord
Still struggling? Please, file an issue, describe your problem, and we will gladly help you.
Here's a list of related projects that have been inspired by Spaceship ZSH.
MIT © Denys Dovhan