{"id":15008056,"url":"https://github.com/JorgeSarricolea/gitbuddy","last_synced_at":"2025-10-30T12:31:20.205Z","repository":{"id":255818947,"uuid":"853672598","full_name":"JorgeSarricolea/gitbuddy","owner":"JorgeSarricolea","description":"Automate standardized commit and PR message generation for clear, consistent documentation.","archived":false,"fork":false,"pushed_at":"2024-10-10T17:30:02.000Z","size":23,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T08:32:17.522Z","etag":null,"topics":["commits","git","github","pull-requests"],"latest_commit_sha":null,"homepage":"","language":"Python","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/JorgeSarricolea.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-07T07:48:01.000Z","updated_at":"2025-01-03T17:52:29.000Z","dependencies_parsed_at":"2024-10-30T14:56:29.671Z","dependency_job_id":"d5358795-1940-4c41-b553-409e29b70a6a","html_url":"https://github.com/JorgeSarricolea/gitbuddy","commit_stats":null,"previous_names":["jorgesarricolea/git-buddy","jorgesarricolea/gitbuddy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorgeSarricolea%2Fgitbuddy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorgeSarricolea%2Fgitbuddy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorgeSarricolea%2Fgitbuddy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorgeSarricolea%2Fgitbuddy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JorgeSarricolea","download_url":"https://codeload.github.com/JorgeSarricolea/gitbuddy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238968283,"owners_count":19560585,"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":["commits","git","github","pull-requests"],"created_at":"2024-09-24T19:14:54.037Z","updated_at":"2025-10-30T12:31:19.917Z","avatar_url":"https://github.com/JorgeSarricolea.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **Installation and Setup Guide for the `gitbuddy` Script on Linux and macOS**\n---\n\nThis guide will walk you through setting up and running the `gitbuddy` script, a handy tool designed to automate common Git tasks and streamline your workflow. With `gitbuddy`, you can easily manage Git operations like adding changes, committing, pulling, and pushing directly from your terminal. Additionally, the script integrates with ChatGPT to help generate commit messages and pull request descriptions.\n\n### Introduction\n`gitbuddy` is a Python-based script that simplifies your Git workflow by automating repetitive tasks. It allows you to perform actions like creating commits and interacting with remote repositories with ease. To enhance your productivity, `gitbuddy` also includes prompt templates for generating commit messages and pull requests using ChatGPT. These prompts are located in the `prompts` folder within the cloned repository and can be used to quickly generate high-quality messages by copying and pasting them into a blank ChatGPT chat.\n\n### 1. **Clone the Repository with the `gitbuddy` Script**\n\nFirst, clone the repository that contains the `gitbuddy` script. Make sure you have `git` installed on your system.\n\n```bash\n# Clone the repository\ngit clone https://github.com/JorgeSarricolea/git-buddy ~/Documents/scripts\n```\n\n\u003e [!IMPORTANT]\nConsider that a folder called `scripts` will be created that will be in `Documents`. This command will download the repository to the `~/Documents/scripts` folder.\n\n### 2. **Make the Script Executable**\n\nOnce the script is cloned, navigate to the folder where the repository was downloaded and make the script executable.\n\n```bash\ncd ~/Documents/scripts\nchmod +x gitbuddy\n```\n\nThis command ensures that the `gitbuddy` script is executable.\n\n### 3. **Add the Script to the `PATH`**\n\nTo run the script from anywhere by simply typing `gitbuddy`, you need to add the folder where the script is located to your system’s `PATH`.\n\n- Edit your shell configuration file (`~/.bashrc`, `~/.bash_profile`, or `~/.zshrc`, depending on your system).\n\n```bash\n# For bash\nnano ~/.bashrc\n# For zsh\nnano ~/.zshrc\n```\n\n- Add the following line at the end of the file:\n\n```bash\nexport PATH=\"$HOME/Documents/scripts:$PATH\"\n```\n\n- Save the file and reload it:\n\n```bash\n# Reload the file\nsource ~/.bashrc  # For bash\nsource ~/.zshrc   # For zsh\n```\n\nNow you can run `gitbuddy` from any directory.\n\n### 4. **Install Python (if needed)**\n\nMake sure you have Python 3 installed, as the script depends on it. Check the Python version on your system:\n\n```bash\npython3 --version\n```\n\nIf you don't have Python 3, you can install it:\n\n- **On Linux (Ubuntu/Debian)**:\n\n```bash\nsudo apt update\nsudo apt install python3\n```\n\n- **On macOS**:\n\n```bash\nbrew install python3\n```\n\n### 5. **Test the Script**\n\nAfter setting everything up, you can test the script.\n\n- Navigate to any Git repository on your machine:\n\n```bash\ncd /path/to/your/repo\n```\n\n- Run the script by typing `gitbuddy`:\n\n```bash\ngitbuddy\n```\n\nThe script will guide you through the process of adding changes, creating a commit with a custom message, and performing `push` or `pull` actions as needed.\n\n---\n\nBy following these steps, you’ll have successfully set up and run the `gitbuddy` script on your Linux or macOS system. You can now use it from anywhere in your terminal to streamline your Git workflow!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJorgeSarricolea%2Fgitbuddy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJorgeSarricolea%2Fgitbuddy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJorgeSarricolea%2Fgitbuddy/lists"}