Package Health Score

90 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
4.17.0	\|	10/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.16.2	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.16.7	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.15.0	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.14.1	\|	08/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (65)

GitHub Stars: 19.53K
Forks: 965
Contributors: 180

Direct Usage Popularity

The npm package spaceship-prompt receives a total of 65 downloads a week. As such, we scored spaceship-prompt popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package spaceship-prompt, we found that it has been starred 19,532 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 180
Funding: Yes

A good and healthy external contribution signal for spaceship-prompt project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 103
Open PR: 27
Last Release: 27 days ago
Last Commit: 27 days ago

Further analysis of the maintenance status of spaceship-prompt based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that spaceship-prompt demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 0 Direct
Versions: 112
Install Size: 199 kB
Dist-tags: 2
# of Files: 85
Maintainers: 2
TS Typings: No

spaceship-prompt has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Spaceship Prompt 🚀⭐

Minimalistic, powerful and extremely customizable `Zsh` prompt

Website | Installation | Configuration | Advanced Usage

_{Built with ❤︎ by
Denys Dovhan and
contributors}

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 the 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.}

✨ Features

Here are some sneak peeks of what Spaceship can show:

Clever hostname and username displaying
Repository statuses (Git and Mercurial are supported)
Runtime environments for various languages (Node.js, Rust, Python, Ruby, Swift, Go, PHP and many others)
Docker version, Kubernetes context and connected machine
Package version (npm, lerna, cargo, composer and others)
Battery level and status
Indicator for jobs in the background ✦
A lot of useful information
Custom information of your choice

Want more features? Please, open an issue or send a pull request.

🤝 Requirements

Before we begin, let's make sure you have the following installed:

Zsh (v5.2 or recent) must be installed. Run the following command to check your version of Zsh:
```
echo $ZSH_VERSION #&gt; 5.8.1
```
Powerline Font or Nerd Font (even better) must be installed and used in your terminal. Fira Code is a popular choice. To check if Powerline Font works for you, run:
```
echo -e "\xee\x82\xa0" #&gt; 
```

🚀 Installation

Here are a few popular methods to install Spaceship. Select the one you use from the list below:

Homebrew

Installing Spaceship via Homebrew is a simple command:

brew install spaceship

Add prompt initialization to your .zshrc:

echo "source $(brew --prefix)/opt/spaceship/spaceship.zsh" &gt;&gt;! ~/.zshrc

Oh-My-Zsh

Clone this repo:

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 Spaceship via npm as you would with any other global package:

npm install -g spaceship-prompt

This command will download Spaceship. It will also ask you to source Spaceship in your ~/.zshrc file.

prezto

Follow prezto-contrib#usage to clone prezto-contrib to the proper location.
Enable the contrib-prompt module (before the prompt module).
Set zstyle ':prezto:module:prompt' theme 'spaceship' in your .zpreztorc.

zim

Add Spaceship to your `.zimrc`:

zmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules

Then, install Spaceship:

zimfw install

antigen

Add the following snippet in your `.zshrc`:

antigen theme spaceship-prompt/spaceship-prompt

antibody

Update your `.zshrc` file with the following line:

antibody bundle spaceship-prompt/spaceship-prompt

zinit

Add the following line to your `.zshrc` where you're adding your other Zsh plugins:

zinit light spaceship-prompt/spaceship-prompt

zgen

Add the following line to your `.zshrc` where you're adding your other Zsh plugins:

zgen load spaceship-prompt/spaceship-prompt spaceship

zplug

Use this command in your `.zshrc` to load Spaceship as prompt theme:

zplug "spaceship-prompt/spaceship-prompt", use:spaceship.zsh, from:github, as:theme

sheldon

Add the following to your `plugins.toml` file (open it with `sheldon edit`):

[plugins.spaceship]
github = "spaceship-prompt/spaceship-prompt"

Or run the following to automatically add it:

sheldon add spaceship --github spaceship-prompt/spaceship-prompt

Arch

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.

Manual

If none of the above methods works for you, you can install Spaceship manually.

Clone this repo somewhere, for example to $HOME/.zsh/spaceship.
Source Spaceship in your ~/.zshrc.

Example

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"

⚙️ Configuration

Spaceship works well out of the box, but you can customize almost everything if you want.

⚙️ Configuration — Tweak the section's behavior with tons of options.
😎 Advanced Usage — Learn how to create a custom section, benefit of per-directory configuration and more.

Additionally, join our community in Discord and follow our Twitter for updates.

🫶 Contributing

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.

💌 Sponsoring

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:

Recurring donations:
One-time donations:
Crypto donations:
- Ethereum: 0x5C9496De5E51D48daf28354DC04d8f9D33955559
- Bitcoin: bc1q5ezjvpgftmx42f9qgdf5lscjz43uh4jf02uvje

🤔 Having trouble?

Find answers on our troubleshooting page or get help from our community.

Issues • Discussions • Discord

Still struggling? Please, file an issue, describe your problem, and we will gladly help you.

👀 Derived Projects

Here's a list of related projects that have been inspired by Spaceship ZSH.

denysdovhan/dotfiles - Dotfiles of Spaceship's author from which Spaceship is originated.
matchai/spacefish - A port of Spaceship ZSH for fish shell intending to achieve complete feature parity.
starship/starship - A blazing-fast, cross-shell prompt written in Rust, heavily inspired by Spaceship ZSH.

📄 License

FAQs

What is spaceship-prompt?

A Zsh prompt for Astronauts. Visit Snyk Advisor to see a full health score report for spaceship-prompt, including popularity, security, maintenance & community analysis.

Is spaceship-prompt popular?

The npm package spaceship-prompt receives a total of 65 weekly downloads. As such, spaceship-prompt popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is spaceship-prompt well maintained?

We found that spaceship-prompt demonstrated a healthy version release cadence and project activity. It has a community of 180 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is spaceship-prompt safe to use?

The npm package spaceship-prompt was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 14 November-2024, at 20:58 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP