athul / shelby

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

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

shelby's Issues

Add Code documentation

Hello @athul ,
Nice to see this beautiful art from you!

It would be very helpful if you are adding documentation in code.

add prebuild binary for raspberry 3B+

Hi there,

I want you build your prompt on my parpberry 3B+, but I don't get it, it's my first attempt to build a go project.

~/source/shelby [master|✔] $ sh -c "$(curl -sL https://git.io/ishelby)"
athul/shelby crit platform linux/armv7 is not supported. Make sure this script is up-to-date and file request at https://github.com/athul/shelby/issues/new

go get -v
error: unknown switch `v'

go build
error: Pfadspezifikation 'build' stimmt mit keinen git-bekannten Dateien überein.

Since the raspi is a very small device a prebuild binary where really great. :-)

Just a question, is this compalibe with tmux ?

thanks and regads Micha

Elvish support

Any plans to support elvish, like Starship does?

Easier setup

Like starship, perhaps simpler lines to add in bashrc :

eval `$(starship init bash)`

Also, in README it would be much more clear if the Usage instructions are included right after install. It's confusing for a newbie. Enjoy ? Can't enjoy unless it's made the default shell.

Making it a Homebrew Package or Homebrew Tap

Making this a homebrew package or homebrew tap will make it easy for Linux and Mac users to install and use Shelby

User/Hostname Support Support

Mostly while using SSH , showing the hostname and username and uname will be super helpful to split between tabs and understanding stuff

Brew update depracted warning

System: M1 Mac 2020
OS: Big Sur 11.5.2

Issue: While running brew upgrade or brew install results in the following error

Warning: Calling bottle :unneeded is deprecated! There is no replacement.
Please report this issue to the athul/tap tap (not Homebrew/brew or Homebrew/core):
  /usr/local/Homebrew/Library/Taps/athul/homebrew-tap/Formula/shelby.rb:6

VirtualENV Support

Adding Support to see whether if you're in a virtual environment

Error downloading, got 500 response from server

when installing using this command: curl -sf https://gobinaries.com/athul/shelby | sh
getting this error in Mac M1

Move Deployment to Goreleaser

Improve Deployments using https://goreleaser.com/

Add Execution Timer

Add an execution timer to output the time taken to run the command

Bug: Directory not listed

When the terminal is cleared using Ctrl+L or ⌘+l, the directory is not listed.

Add more icons for git actions

Adding more icons to Git processes like

• Ahead or Behind
• Staged but not commited
• Stashed
  etc....

This will only be possible after #13

could you add a space after the prompt symbol?

Maybe this is not an issue outside of z-shell on Void Linux, but for me there is a lack of a space after the  symbol making the command annoyingly right up against the symbol. If you could add a space (or tell me what I need to append one using an environmental variable) I would appreciate it immensely.

show root user all the time

Hey,

would it be possible to add a config variable or option to show the the user root if I'am logged in as user 0.

Thanks
Micha

Refactoring Git Functions with git2go

Change the Git functions to git2go. This way we could remove some clutter and maybe improve speed.

Show file location even in git folders

Full directory location is not shown in git folders, just the folder name. Better if full location is shown.

Terminal Gif

Soory For Missusing the issues panel.
But if it please , can u tell me which application/webpage you used to create that beautifull terminal gif in readme.md