athul/shelby

Shelby is a fast ⚡️ ,lightweight ☁️ ,minimal✨, shell prompt written in Pure Go.

Installation

Follow the steps below(Linux and macOS), and Post Installation Instructions

• Run with https://gobinaries.com

$ curl -sf https://gobinaries.com/athul/shelby | sh

OR For macOS Users, install via Homebrew

brew install athul/tap/shelby

OR

• Download the binary from the WorkFlow Artifacts(Only for Linux)
• You might wanto to make the binary executable, run chmod +x <binary_name>
• Move the Binary to /usr/local/bin/

Build From Source

• Clone the Repo
• Run go get -v
• Run go build
• Move the Binary to ~/.local/bin/shelby

Post Installation Instructions

You must have to add the below code to either the .bashrc or .zshrc or .profile file inorder to Shelby to fully work.

The prompt symbol is ❯ and changes to red if the previous command exited with an error.

Bash

Add this to your .bashrc file:

eval "$(shelby init bash)"

Zsh

Add this to your .zshrc file:

eval "$(shelby init zsh)"

Extra Bits

• Displays the Current Git Branch
• ✔ shows if any staged files are present
• [+] shows if you've got Untracked Files
  • [2+] shows if you've got 2 untracked files
• [!] shows if you've got Unstaged Files
  • [3!] shows if you've got 3 unstaged files
• ↑ if your HEAD is ahead
• ↓ if your HEAD is behind
• ⇅ if your HEAD is diverged
• Dispalys any VirtualENVs you're working in
• Displays Username and Hostname of the machine while in SSH
• Small Size(~=2MB)

Inspired From

• StarShip by @matchai
• SpaceShip by @denysdovhan

Code reused from ❤️

• Mímir by @talal
• Powerline-Go by @justjanne

Support My work

Donation: UPI ID: athul8720@oksbi

Logo Made by Sreeram aka @fillerink

The Installation Script can be found at https://github.com/athul/autom