{"id":13678820,"url":"https://github.com/athul/shelby","last_synced_at":"2025-08-20T12:32:20.103Z","repository":{"id":50356453,"uuid":"225285990","full_name":"athul/shelby","owner":"athul","description":"Shelby is a fast ⚡️ , lightweight ☁️ , minimal✨,  shell prompt written in Go. ","archived":false,"fork":false,"pushed_at":"2022-02-06T15:31:11.000Z","size":32813,"stargazers_count":193,"open_issues_count":5,"forks_count":16,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-10T02:20:25.870Z","etag":null,"topics":["fast","golang","minimal","prompt","shell","shell-prompt","zsh"],"latest_commit_sha":null,"homepage":"https://athul.github.io/shelby","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/athul.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-02T04:34:49.000Z","updated_at":"2024-11-13T08:37:27.000Z","dependencies_parsed_at":"2022-09-26T17:00:22.561Z","dependency_job_id":null,"html_url":"https://github.com/athul/shelby","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athul%2Fshelby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athul%2Fshelby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athul%2Fshelby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athul%2Fshelby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/athul","download_url":"https://codeload.github.com/athul/shelby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230423564,"owners_count":18223435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fast","golang","minimal","prompt","shell","shell-prompt","zsh"],"created_at":"2024-08-02T13:00:58.704Z","updated_at":"2024-12-19T11:13:08.331Z","avatar_url":"https://github.com/athul.png","language":"Go","funding_links":[],"categories":["Themes","Go","Packages"],"sub_categories":["ZSH on Windows","Prompts"],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"/assets/shelby_logo.png\" width=\"350px\"/\u003e\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Build Status](https://travis-ci.org/athul/shelby.svg?branch=master)](https://travis-ci.org/athul/shelby) ![](https://github.com/athul/shelby/workflows/Starboy/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/athul/shelby)](https://goreportcard.com/report/github.com/athul/shelby)\n\n\u003c/div\u003e\n\nShelby is a fast ⚡️ ,lightweight ☁️ ,minimal✨, shell prompt written in Pure Go. \n\n![](assets/shelby.gif)\n\n-------\n## Installation\nFollow the steps below(Linux and macOS), and **Post Installation Instructions**\n- Run with https://gobinaries.com\n\n```sh\n$ curl -sf https://gobinaries.com/athul/shelby | sh\n```\n\n---\nOR\nFor **macOS** Users, install via _*Homebrew*_\n\n```bash\nbrew install athul/tap/shelby\n```\n\n----\nOR\n- Download the binary from the [WorkFlow Artifacts](https://github.com/athul/shelby/actions?query=workflow%3A%22Go+Build%22)(Only for Linux)\n- You might wanto to make the binary executable, run `chmod +x \u003cbinary_name\u003e`\n- Move the Binary to `/usr/local/bin/`\n\nBuild From Source\n\n- Clone the Repo\n- Run `go get -v`\n- Run `go build`\n- Move the Binary to `~/.local/bin/shelby`\n\n## Post Installation Instructions\n\n\u003e You must have to add the below code to either the `.bashrc` or `.zshrc` or `.profile` file inorder to Shelby to fully work.\n\nThe prompt symbol is `❯` and changes to red if the previous\ncommand exited with an error.\n\n### Bash\n\nAdd this to your `.bashrc` file:\n\n```bash\neval \"$(shelby init bash)\"\n```\n\n### Zsh\n\nAdd this to your `.zshrc` file:\n\n```zsh\neval \"$(shelby init zsh)\"\n```\n\n\n### Extra Bits\n- Displays the Current Git Branch\n- `✔` shows if any staged files are present\n- `[+]` shows if you've got Untracked Files\n  - `[2+]` shows if you've got 2 untracked files\n- `[!]` shows if you've got Unstaged Files\n  - `[3!]` shows if you've got 3 unstaged files\n- `↑` if your HEAD is ahead\n- `↓` if your HEAD is behind\n- `⇅` if your HEAD is diverged\n- Dispalys any VirtualENVs you're working in\n- Displays **Username** and **Hostname** of the machine while in SSH\n- Small Size(~=2MB)\n\n\n### Inspired From\n- [StarShip by @matchai](https://starship.rs)\n- [SpaceShip by @denysdovhan](https://github.com/denysdovhan/spaceship-prompt)\n\n### **Code reused from** :heart:\n- [Mímir by @talal](https://github.com/talal/mimir)\n- [Powerline-Go by @justjanne](https://github.com/justjanne/powerline-go/)\n\n## Support My work\n\n\u003ccenter\u003e\u003cp \u003e\u003cimg height='100' style='border:0px;height:36px;' src='https://imgix.bustle.com/uploads/image/2019/5/2/ffa82ad4-937e-412c-9bfd-33cb9252e88e-instagram-donate.jpg?w=1020\u0026h=576\u0026fit=crop\u0026crop=faces\u0026auto=format\u0026q=70' border='0' alt='Donations' /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003ch3\u003eDonation: UPI ID: \u003cb\u003eathul8720@oksbi\u003c/b\u003e\u003c/h3\u003e\n\u003c/center\u003e\n\n\n### \n\n**Logo Made by** [Sreeram aka @fillerink](https://github.com/fillerink)\n\nThe Installation Script can be found at https://github.com/athul/autom\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathul%2Fshelby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fathul%2Fshelby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathul%2Fshelby/lists"}