{"id":16785597,"url":"https://github.com/allancapistrano/gbc","last_synced_at":"2025-03-22T00:32:25.254Z","repository":{"id":180152381,"uuid":"664674907","full_name":"AllanCapistrano/gbc","owner":"AllanCapistrano","description":"Git Better Commit (gbc) is a simple CLI in Go for writing better commits.","archived":false,"fork":false,"pushed_at":"2023-07-30T14:17:31.000Z","size":31660,"stargazers_count":30,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T06:35:57.397Z","etag":null,"topics":["cli","commit-message","golang"],"latest_commit_sha":null,"homepage":"","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/AllanCapistrano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"allancapistrano","custom":"https://buymeacoffee.com/allancapistrano"}},"created_at":"2023-07-10T13:53:16.000Z","updated_at":"2024-07-20T05:33:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"b86d372a-41c9-448a-ac89-5196bcc98f90","html_url":"https://github.com/AllanCapistrano/gbc","commit_stats":null,"previous_names":["allancapistrano/gbc"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllanCapistrano%2Fgbc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllanCapistrano%2Fgbc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllanCapistrano%2Fgbc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AllanCapistrano%2Fgbc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AllanCapistrano","download_url":"https://codeload.github.com/AllanCapistrano/gbc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244890102,"owners_count":20527030,"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":["cli","commit-message","golang"],"created_at":"2024-10-13T08:09:49.364Z","updated_at":"2025-03-22T00:32:25.243Z","avatar_url":"https://github.com/AllanCapistrano.png","language":"Go","funding_links":["https://github.com/sponsors/allancapistrano","https://buymeacoffee.com/allancapistrano","https://www.buymeacoffee.com/allancapistrano"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eGit Better Commit\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./data/screenshots/gbc-v110-execution.gif\" alt=\"gbc v1.1.0 execution\"\u003e\n\u003c/p\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eWith emojis\u003c/summary\u003e\n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"./data/screenshots/gbc-v110-execution-emojis.gif\" alt=\"gbc v1.1.0 execution with emojis\"\u003e\n  \u003c/p\u003e\n\u003c/details\u003e\n\n------------\n\n## :book: Description ##\n**Git Better Commit (gbc) is a command line interface written in Golang that provides a simple way to write commits following the [Conventional Commits](https://www.conventionalcommits.org/).**\n\n------------\n\n## :computer: How to use\n\n\u003cdetails open\u003e\n  \u003csummary\u003e\u003ch3\u003eInstall gbc\u003c/h3\u003e\u003c/summary\u003e\n  \n  Follow the next steps to install **gbc**:\n\n  1. Make sure you already have [curl](https://curl.se/) installed on your machine;\n  2. Paste this command in your terminal:\n     ```powershell\n     bash -c \"$(curl --fail --show-error --silent --location https://raw.githubusercontent.com/AllanCapistrano/gbc/main/scripts/install.sh)\"\n     ```\n  3. You can check if **gbc** is installed by typing `gbc --version` in your terminal.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003eInstall gbc for Termux\u003c/h3\u003e\u003c/summary\u003e\n  \n  Follow the next steps to install **gbc** for [Termux](https://termux.dev/en/):\n  \n  1. Make sure you already have [curl](https://curl.se/) installed;\n  2. Paste this command in your terminal:\n     ```powershell\n     bash -c \"$(curl --fail --show-error --silent --location https://raw.githubusercontent.com/AllanCapistrano/gbc/main/scripts/install-termux.sh)\"\n     ```\n  3. You can check if **gbc** is installed by typing `gbc --version` in your terminal.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003eUsing gbc\u003c/h3\u003e\u003c/summary\u003e\n  \n  Once you have **gbc** installed, after adding the file(s) to commit, type `gbc` in your terminal, select the **commit type** using the **arrows keys**, and press **enter**. After that, enter the **commit message** you want.\n\n  You can type `gbc --help` to see the allowed command options or `gbc help \u003ccommit type\u003e` to see a short description and basic example of each **commit type**.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003eChanging the defaults emojis\u003c/h3\u003e\u003c/summary\u003e\n  \n  You can change the emojis in the `gbc.conf` file, available in `$HOME/.config/gbc`. Just change the `emojis = {...}`. Note that you need to use Emojis Shortcodes, you can get them in [Emoji Picker](https://github-emoji-picker.rickstaa.dev/).\n  \n  ###### Make sure to follow the formatting, otherwise the change will not be applied. ######\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003eAllowing commits messages with emojis\u003c/h3\u003e\u003c/summary\u003e\n  \n  You can allow **commit messages with emojis** in the `gbc.conf` file, available in `$HOME/.config/gbc`. Just change the `enableEmojis` to `true`. \n  \n  ###### Make sure to follow the formatting, otherwise the change will not be applied. ######\n\n  The result will be something like:\n  ```powershell\n  🐛 fix: updateUser method\n  ```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003eBuild gbc\u003c/h3\u003e\u003c/summary\u003e\n  \n  To build **gbc** in your machine, you can follow the next steps:\n  \n  1. Make sure you already have [Go](https://go.dev/) installed;\n  2. Clone this repository or download the `.zip` file;\n  3. Open the project directory in your terminal;\n  4. Install the dependencies:\n     ```powershell\n     go mod download\n     ```\n     or\n     ```powershell\n     go mod tidy\n     ```\n  5. Then build the project:\n     ```powershell\n     go build -o bin/gbc main.go\n     ```\n     If you get [`GLIBC not found`](https://github.com/AllanCapistrano/gbc/issues/13) error, try:\n     ```powershell\n     CGO_ENABLED=0 go build -o bin/gbc main.go\n     ```\n  To use the settings file:\n  1. Create the **gbc** config directory:\n     ```powershell\n     mkdir -p $HOME/.config/gbc\n     ```\n  2. Move the `gbc.conf` file into the configuration directory::\n     ```powershell\n     mv ./config/gbc.conf $HOME/.config/gbc\n     ```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003eUninstall gbc\u003c/h3\u003e\u003c/summary\u003e\n  \n  To uninstall **gbc** run the following command in your terminal:\n  \n  ```powershell\n  bash -c \"$(curl --fail --show-error --silent --location https://raw.githubusercontent.com/AllanCapistrano/gbc/main/scripts/uninstall.sh)\"\n  ```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003ch3\u003eUninstall gbc from Termux\u003c/h3\u003e\u003c/summary\u003e\n  \n  To uninstall **gbc** from [Termux](https://termux.dev/en/) run the following command:\n  \n  ```powershell\n  bash -c \"$(curl --fail --show-error --silent --location https://raw.githubusercontent.com/AllanCapistrano/gbc/main/scripts/uninstall-termux.sh)\"\n  ```\n\u003c/details\u003e\n\n------------\n\n## :man_technologist: Author ##\n\n| [![Allan Capistrano](https://github.com/AllanCapistrano.png?size=100)](https://github.com/AllanCapistrano) |\n| -----------------------------------------------------------------------------------------------------------|\n| [Allan Capistrano](https://github.com/AllanCapistrano)                                                     |\n\n\u003cp\u003e\n    \u003ch3\u003eMy socials:\u003c/h3\u003e\n    \u003ca href=\"https://github.com/AllanCapistrano\"\u003e\n        \u003cimg src=\"https://github.com/AllanCapistrano/AllanCapistrano/blob/master/assets/github-square-brands.png\" alt=\"Github icon\" width=\"5%\"\u003e\n    \u003c/a\u003e\n    \u0026nbsp\n    \u003ca href=\"https://www.linkedin.com/in/allancapistrano/\"\u003e\n        \u003cimg src=\"https://github.com/AllanCapistrano/AllanCapistrano/blob/master/assets/linkedin-brands.png\" alt=\"Linkedin icon\" width=\"5%\"\u003e\n    \u003c/a\u003e \n    \u0026nbsp\n    \u003ca href=\"https://mail.google.com/mail/u/0/?view=cm\u0026fs=1\u0026tf=1\u0026source=mailto\u0026to=asantos@ecomp.uefs.br\"\u003e\n        \u003cimg src=\"https://github.com/AllanCapistrano/AllanCapistrano/blob/master/assets/envelope-square-solid.png\" alt=\"Email icon\" width=\"5%\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n------------\n\n## :pray: Support ##\n\n**Please :star: this repository if this project is useful or has helped you.**\n\n[![\"Buy Me A Coffee\"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/allancapistrano)\n\n------------\n\n## :balance_scale: License ##\n[GPL-3.0 License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallancapistrano%2Fgbc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallancapistrano%2Fgbc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallancapistrano%2Fgbc/lists"}