Go to file
Kevin Song 572a07c72d fix: Correct broken zsh init in absence of precmd_functions (#180) 2019-08-18 07:07:38 -04:00
.github Clean up feature request template comment 2019-04-30 14:30:40 -04:00
ci ci: Remove brew bump formula from CI 2019-08-13 19:41:42 -04:00
docs fix a few typos (#178) 2019-08-17 20:50:42 -07:00
media docs: Add vuepress with initial docs (#99) 2019-07-19 16:18:52 -04:00
src fix: Correct broken zsh init in absence of precmd_functions (#180) 2019-08-18 07:07:38 -04:00
tests feat: Display Vi mode as PROMPT (#169) 2019-08-17 12:33:19 -07:00
.all-contributorsrc docs: add cappyzawa as a contributor (#175) 2019-08-17 16:03:26 -04:00
.dockerignore Add docker for integration tests (#37) 2019-04-28 13:34:46 -04:00
.gitignore feat: Add option to control git directory truncation (#165) 2019-08-16 20:29:22 -07: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
Cargo.lock chore(bump): v0.10.1 2019-08-16 15:04:12 -04:00
Cargo.toml chore(bump): v0.10.1 2019-08-16 15:04:12 -04:00
LICENSE docs: Attribute copyright to Starship Contributors (#115) 2019-07-25 12:50:29 -04:00
README.md docs: Small doc touch-ups (#176) 2019-08-17 16:38:20 -04:00
azure-pipelines.yml ci: Remove remaining reference to bump brew formula 2019-08-13 19:42:25 -04:00
integration_test Add support for prompt configuration (#62) 2019-06-10 15:56:17 +01:00

README.md


Starship – Cross-shell prompt

Crates.io version Azure Pipelines Build Status All Contributors Chat on Discord


Website · Installation · Configuration

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
The prompt shows information you 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 Ruby version (💎).
  • Current Python version (🐍)
  • Current Go version (🐹)
  • Current version of package in current directory (📦)
    • npm (Node.js)
    • cargo (Rust)
    • poetry (Python)
  • 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
  • Execution time of the last command if it exceeds the set threshold
  • Indicator for jobs in the background ()

🚀 Installation

Prerequisites

Getting Started

  1. Install the starship binary:

    Download archives of precompiled binaries if you don't use the platforms below.

    Homebrew

    $ brew install starship
    

    Rust (v1.33 or higher)

    $ cargo install starship
    
  2. Add the init script to your shell's config file:

    Bash

    Add the following to the end of ~/.bashrc:

    # ~/.bashrc
    
    eval "$(starship init bash)"
    

    Fish

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

    # ~/.config/fish/config.fish
    
    eval (starship init fish)
    

    Zsh

    Add the following to the end of ~/.zshrc:

    # ~/.zshrc
    
    eval "$(starship init zsh)"
    

🔧 Configuration

For details on how to configure Starship, check out our documentation.

🤝 Contributing

We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a good first issue.

High Priority Needs

  • 👩‍💼 Product Manager
    • We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction!
  • 👩‍🎨 Designer
    • Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas!
  • 👩‍💻 Rust Developer
    • There is a lot of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I (@matchai) am a beginner to Rust. Come point us in the right direction!

If you are interested in helping contribute to starship, please take a look at our Contributing Guide. Also, feel free to drop into our Discord server and say hi. 👋

Contributors

Thanks goes to these wonderful people (emoji key):

Matan Kushner
Matan Kushner

💻 🎨 🤔 🚇 🚧 👀 ⚠️
John Letey
John Letey

💻 🤔 👀 ⚠️
Tim Mulqueen
Tim Mulqueen

💻 🤔 👀 ⚠️
Tiffany Le-Nguyen
Tiffany Le-Nguyen

🤔 🚧 👀 📖
​Snuggle
Snuggle

🎨 🤔 🚧 👀
Ryan Leckey
Ryan Leckey

👀
Youssef Habri
Youssef Habri

💻
Kevin Song
Kevin Song

🐛 💻 📖 ⚠️
Andrew Dassonville
Andrew Dassonville

🐛 💻
MaT1g3R
MaT1g3R

💻 📖 ⚠️
André Zanellato
André Zanellato

💻 📖 ⚠️
Saghm Rossi
Saghm Rossi

💻 📖 ⚠️
Shu Kutsuzawa
Shu Kutsuzawa

💻 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!


Starship rocket icon

📝 License

Copyright © 2019-present, Starship Contributors.
This project is ISC licensed.