starship

mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-28 07:46:28 +00:00

The minimal, blazing-fast, and infinitely customizable prompt for any shell!

Go to file

Matan Kushner c8975dfbb6 v0.3.0		2019-07-19 22:08:43 -04:00
.github	Clean up feature request template comment	2019-04-30 14:30:40 -04:00
ci	ci: Use Python v3.6.9 in CI (#101 )	2019-07-19 15:56:36 -04:00
docs	docs: Add vuepress with initial docs (#99 )	2019-07-19 16:18:52 -04:00
media	docs: Add vuepress with initial docs (#99 )	2019-07-19 16:18:52 -04:00
src	refactor: Improve logging where lacking	2019-07-19 18:45:38 -04:00
tests	docs: Add vuepress with initial docs (#99 )	2019-07-19 16:18:52 -04:00
.all-contributorsrc	docs: add sirMerr as a docs contributor (#103 )	2019-07-19 16:21:53 -04:00
.dockerignore	Add docker for integration tests (#37 )	2019-04-28 13:34:46 -04:00
.gitignore	docs: Add vuepress with initial docs (#99 )	2019-07-19 16:18:52 -04:00
azure-pipelines.yml	ci: Set releases to not be pre-releases	2019-07-15 00:04:53 -04:00
Cargo.lock	v0.3.0	2019-07-19 22:08:43 -04:00
Cargo.toml	v0.3.0	2019-07-19 22:08:43 -04:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md (#42 )	2019-04-30 23:30:42 -04:00
CONTRIBUTING.md	docs: Add CONTRIBUTNG.md (#79 )	2019-06-15 11:23:29 +01:00
integration_test	Add support for prompt configuration (#62 )	2019-06-10 15:56:17 +01:00
LICENSE	Add LICENSE	2019-04-13 00:47:49 -04:00
README.md	docs: Add links to website and missing detail (#105 )	2019-07-19 21:39:35 -04:00

README.md

Website · Installation · Configuration

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! The prompt shows information need while you're working, while staying sleek and out of the way.

Starship with Hyper and One Dark

Features

Prompt character turns red if the last command exits with non-zero code.
Current username if not the same as the logged-in user.
Current Node.js version(⬢).
Current Rust version (🦀).
Current Python version (🐍).
Current Go version (🐹).
Package version of package in current directory (📦).
Current battery level and status
Current Git branch and rich repo status:
- = — conflicting changes
- ⇡ — ahead of remote branch
- ⇣ — behind of remote branch
- ⇕ — diverged changes
- ? — untracked changes
- $ — stashed changes
- ! — modified files
- + — added files
- » — renamed files
- ✘ — deleted files
PLANNED #80 – Indicator for jobs in the background (✦).
PLANNED #104 – Execution time of the last command if it exceeds the set threshold.

Installation

Prerequisites

Rust v1.33 or higher
A Powerline font installed and enabled in your terminal (for example, try Fira Code).

Getting Started

Install the starship binary:
```
cargo install starship
```
Add the init script to your shell's config file:

Bash / Zsh

Add the following to the end of ~/.bashrc or ~/.zshrc:
```
# ~/.bashrc or ~/.zshrc

eval "$(starship init $0)"
```
Fish

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

eval (starship init fish)
```