Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/athul/shelby
Shelby is a fast ⚡️ , lightweight ☁️ , minimal✨, shell prompt written in Go.
https://github.com/athul/shelby
fast golang minimal prompt shell shell-prompt zsh
Last synced: 4 days ago
JSON representation
Shelby is a fast ⚡️ , lightweight ☁️ , minimal✨, shell prompt written in Go.
- Host: GitHub
- URL: https://github.com/athul/shelby
- Owner: athul
- License: gpl-3.0
- Created: 2019-12-02T04:34:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-06T15:31:11.000Z (almost 3 years ago)
- Last Synced: 2024-08-02T13:24:45.374Z (3 months ago)
- Topics: fast, golang, minimal, prompt, shell, shell-prompt, zsh
- Language: Go
- Homepage: https://athul.github.io/shelby
- Size: 31.3 MB
- Stars: 191
- Watchers: 2
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/athul/shelby)  [](https://goreportcard.com/report/github.com/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
```sh
$ curl -sf https://gobinaries.com/athul/shelby | sh
```
---
OR
For **macOS** Users, install via _*Homebrew*_
```bash
brew install athul/tap/shelby
```
----
OR
- Download the binary from the [WorkFlow Artifacts](https://github.com/athul/shelby/actions?query=workflow%3A%22Go+Build%22)(Only for Linux)
- You might wanto to make the binary executable, run `chmod +x `
- 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:
```bash
eval "$(shelby init bash)"
```
### Zsh
Add this to your `.zshrc` file:
```zsh
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](https://starship.rs)
- [SpaceShip by @denysdovhan](https://github.com/denysdovhan/spaceship-prompt)
### **Code reused from** :heart:
- [Mímir by @talal](https://github.com/talal/mimir)
- [Powerline-Go by @justjanne](https://github.com/justjanne/powerline-go/)
## Support My work
Donation: UPI ID: athul8720@oksbi
###
**Logo Made by** [Sreeram aka @fillerink](https://github.com/fillerink)
The Installation Script can be found at https://github.com/athul/autom