configs/home/.zsh-distrobox/themes/spaceship-prompt/docs/index.md

5.2 KiB

template title hide hero features companies
index.html Minimalistic, powerful and extremely customizable Zsh prompt
navigation
title subtitle install_button source_button
Minimalistic, powerful and extremely customizable Zsh prompt It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship. Getting Started Source Code
title image description
Clean and simple /assets/images/what-is-needed.svg The prompt is not overloaded, it shows only what you need at the moment (current directory, git branch, etc).
title image description
Easy to set up /assets/images/out-of-the-box.svg The prompt works right after installation without any additional configuration. install it and use it.
title image description
Configurable /assets/images/configurable.svg The prompt is zero-config, but if a customization is needed, it provides an easy-to-use interface for customization.
title list
Used daily by marvelous folks at
name logo
Wix https://cdn.svgporn.com/logos/wix.svg
name logo
Google https://cdn.svgporn.com/logos/google.svg
name logo
Siemens https://upload.wikimedia.org/wikipedia/commons/5/5f/Siemens-logo.svg
name logo
Microsoft https://cdn.svgporn.com/logos/microsoft.svg
name logo
Adobe https://upload.wikimedia.org/wikipedia/commons/6/6e/Adobe_Corporate_logo.svg
name logo
Docker https://cdn.svgporn.com/logos/docker.svg
name logo
Shopify https://upload.wikimedia.org/wikipedia/commons/0/0e/Shopify_logo_2018.svg
name logo
GitHub https://cdn.svgporn.com/logos/github.svg
name logo
Red Hat https://cdn.svgporn.com/logos/redhat.svg
name logo
Amazon Web Services https://cdn.svgporn.com/logos/aws.svg
name logo
Facebook https://cdn.worldvectorlogo.com/logos/facebook-7.svg
name logo
npm https://cdn.svgporn.com/logos/npm.svg
name logo
Unity Technologies https://cdn.worldvectorlogo.com/logos/unity-technologies-logo.svg
name logo
Angular https://cdn.svgporn.com/logos/angular.svg
name logo
Mozilla https://cdn.svgporn.com/logos/mozilla.svg
name logo
Framer https://cdn.svgporn.com/logos/framer.svg
name logo
Grammarly https://cdn.svgporn.com/logos/grammarly.svg
name logo
Skyscanner https://upload.wikimedia.org/wikipedia/commons/9/94/Skyscanner_Logo_LockupHorizontal_SkyBlue_RGB.svg
name logo
Node.js https://cdn.svgporn.com/logos/nodejs.svg
name logo
Vue Storefront https://cdn.worldvectorlogo.com/logos/vue-storefront.svg
name logo
Coinbase https://cdn.worldvectorlogo.com/logos/coinbase-1.svg
name logo
Suse https://cdn.svgporn.com/logos/suse.svg

Welcome aboard, Astronaut!

SWUbanner

Features

Spaceship is a superpowered 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.

Here are some sneak picks 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 pull request.

Getting Started

Installing Spaceship is simple and quick. It's configurable and easy to use.

Installation{ .md-button } Configuration{ .md-button }

Support

Join our community and consider contributing to the project.

:material-hand-heart: Contribute{ .md-button } :fontawesome-brands-twitter: Twitter{ .md-button } :fontawesome-brands-discord: Discord{ .md-button } :fontawesome-brands-github: Discussions{ .md-button }

License

MIT © Denys Dovhan