{"id":15065612,"url":"https://github.com/raverona/git-branch-color-status","last_synced_at":"2026-01-03T04:54:03.145Z","repository":{"id":44974784,"uuid":"180802118","full_name":"raverona/git-branch-color-status","owner":"raverona","description":"Displays the status of the current directory git branch with symbols and colors","archived":false,"fork":false,"pushed_at":"2022-01-15T05:32:26.000Z","size":143,"stargazers_count":0,"open_issues_count":15,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-08T09:30:41.430Z","etag":null,"topics":["bash","branch","color","git","ps1"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/git-branch-color-status","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raverona.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-11T13:49:52.000Z","updated_at":"2020-03-26T18:10:34.000Z","dependencies_parsed_at":"2022-09-23T10:53:36.629Z","dependency_job_id":null,"html_url":"https://github.com/raverona/git-branch-color-status","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raverona%2Fgit-branch-color-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raverona%2Fgit-branch-color-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raverona%2Fgit-branch-color-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raverona%2Fgit-branch-color-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raverona","download_url":"https://codeload.github.com/raverona/git-branch-color-status/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243806114,"owners_count":20350783,"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":["bash","branch","color","git","ps1"],"created_at":"2024-09-25T00:43:08.434Z","updated_at":"2026-01-03T04:54:03.106Z","avatar_url":"https://github.com/raverona.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Git Branch Color Status\nversion: 1.1.4  \nstatus: actively developed\n\n## What is this?\n\nIt's a software to inform you the current state of your repository through symbols and colors\n\n## How does it work?\n\nIt runs Bash scripts that checks the state of the git repository present on the current directory and displays it through symbols and colors\n\n## Requirements\n\n- [NodeJS](https://nodejs.org) and [NPM](https://www.npmjs.com/)\n- [Bash](https://www.gnu.org/software/bash/)\n\n## How to use it?\n\n- Install it by executing `sudo npm install -g git-branch-color-status`\n- Configure your PS1 on your .bashrc file like this `PS1+=\"\\$(git-branch-color-status)\";`\n\n### Options available\n\n| Option   | Description                                                                  | Type    | Number of  Arguments | Available Arguments          | Default Value | Syntax                                                                                                                                  |\n|:--------:|:----------------------------------------------------------------------------:|:-------:|:--------------------:|:----------------------------:|:-------------:|:----------------------------------------------------------------------------------------------------------------------------------------|\n| Version  | displays the current version \u003cbr\u003enumber and exit                             | Boolean | 0                    | N/A                          | false         | -v \u003cbr\u003e--version                                                                                                                        |\n| Color    | enable colored output                                                        | Boolean | 0                    | N/A                          | true          | -c \u003cbr\u003e--color                                                                                                                          |\n| No Color | disable colored output                                                       | Boolean | 0                    | N/A                          | false         | --no-c \u003cbr\u003e--no-color                                                                                                                   |\n| Bracket  | specify the type of brackets \u003cbr\u003edisplayed surrounding the \u003cbr\u003ebranch status | String  | 1                    | round, \u003cbr\u003esquare, \u003cbr\u003ecurly | square        | -b round \u003cbr\u003e-b \"round\" \u003cbr\u003e-b=round \u003cbr\u003e-b=\"round\" \u003cbr\u003e--bracket round \u003cbr\u003e--bracket \"round\" \u003cbr\u003e--bracket=round \u003cbr\u003e--bracket=\"round\" |\n\n### Exemples\n\n| Command                                          | Output                                                                                                                                                                 |\n|:------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|\n| `git-branch-color-status`                        | ![word \"master\" colored in green surrounded by square brackets](doc/img/examples/ColoredExample.png \"colored branch name surrounded by square brackets\")               |\n| `git-branch-color-status --no-color`             | ![word \"master\" colored in white surrounded by square brackets](doc/img/examples/NoColorExample.png \"non-colored branch name surrounded by square brackets\")           |\n| `git-branch-color-status --no-c --bracket=round` | ![word \"master\" colored in white surrounded by round brackets](doc/img/examples/NoColorRoundBracketExample.png \"non-colored branch name surrounded by round brackets\") | \n\n## Symbols and Colors available\n\n### Symbols available\n\n| Symbol | Description                           |\n|:------:|:--------------------------------------|\n| `\u003e`    | There are renamed files being tracked |\n| `*`    | Your branch is ahead of remote        |\n| `+`    | There are new files being tracked     |\n| `?`    | There are untracked files             |\n| `x`    | There are deleted tracked files       |\n| `!`    | There are modified tracked files      |\n\n### Colors available\n\n| Color                                                                    | Description                           |\n|:------------------------------------------------------------------------:|---------------------------------------|\n| ![word \"Green\" colored in green](doc/img/text/GreenText.png \"Green\")     | Working tree clean, nothing to commit |\n| ![word \"Yellow\" colored in yellow](doc/img/text/YellowText.png \"Yellow\") | Your branch is ahead of remote branch |\n| ![word \"Red\" colored in red](doc/img/text/RedText.png \"Red\")             | Working tree not clean                |\n\n## How to contribute\n\nFork this project, create a branch, push your changes and make a pull request destined to the master branch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraverona%2Fgit-branch-color-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraverona%2Fgit-branch-color-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraverona%2Fgit-branch-color-status/lists"}