Coder Social home page Coder Social logo

andrewda / starship Goto Github PK

View Code? Open in Web Editor NEW

This project forked from starship/starship

1.0 1.0 0.0 5.84 MB

β˜„πŸŒŒοΈ The cross-shell prompt for astronauts.

Home Page: https://starship.rs

License: ISC License

Shell 0.63% Rust 97.17% Dockerfile 2.21%

starship's Introduction


Starship – Cross-shell prompt

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

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

Getting Started

  1. Install the starship binary:

    cargo install starship
  2. 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)

πŸ”§ 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

πŸ› πŸ’»

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.

starship's People

Contributors

matchai avatar dependabot-preview[bot] avatar jletey avatar tiffafoo avatar multimo avatar dependabot[bot] avatar allcontributors[bot] avatar chipbuster avatar youssefhabri avatar snuggle avatar

Stargazers

 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.