extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-11-22 16:23:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
☄🌌️ The minimal, blazing-fast, and infinitely customizable prompt for any shell!
40 Commits 9 Branches 144 Tags 163 MiB
Rust 95.6%
Shell 2.9%
PowerShell 1.1%
Lua 0.1%
e314cbbf77
Go to file
Matan Kushner e314cbbf77
Add features and shells to README
2019-04-13 00:45:33 -04:00
benches Fix up benchmarks 2019-04-12 19:13:14 -04:00
src Add fish_prompt 2019-04-13 00:34:56 -04:00
.gitignore Add segment structure and logic 2019-04-03 20:14:26 -04:00
azure-pipelines.yml Add tests to dir home truncation 2019-04-04 14:32:22 -04:00
Cargo.lock Revert "Parallelize nodejs file checks" 2019-04-12 13:10:31 -04:00
Cargo.toml Revert "Parallelize nodejs file checks" 2019-04-12 13:10:31 -04:00
fish_prompt.fish Add fish_prompt 2019-04-13 00:34:56 -04:00
README.md Add features and shells to README 2019-04-13 00:45:33 -04:00

README.md

Starship ✨🚀

The cross-shell prompt for astronauts.

⚠️ This is very much work in progress, so please don't try to use it just yet!

Starship is a Rust port of the minimalistic, powerful, and extremely customizable prompt Spaceship ZSH.

Features

Prompt segments

  • Prompt character turns red if the last command exits with non-zero code.
  • Current Node.js version(⬢).
  • Current Rust version (𝗥).
  • Current battery level and status
  • Current Git branch and rich repo status.
  • Indicator for jobs in the background (✦).
  • Execution time of the last command if it exceeds the set threshold.

Shell support

  • Fish shell
  • Z Shell
  • Bash

Setup

Prerequisites

  • Rust v1.33 or higher
  • Fisher v3

Getting Started

  1. cd to the root of the starship repo

  2. Install the starship binary:

    cargo install --path .

  3. Install the fish shell prompt with fisher:

    fisher $PWD