{"id":27457685,"url":"https://github.com/pythonicforge/commitpal","last_synced_at":"2025-04-15T19:48:19.994Z","repository":{"id":288006881,"uuid":"966089739","full_name":"pythonicforge/CommitPal","owner":"pythonicforge","description":"🦾 Your AI-powered terminal buddy for writing smart, stylish, and crystal-clear Git commit messages ","archived":false,"fork":false,"pushed_at":"2025-04-15T04:20:23.000Z","size":203,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T04:37:46.260Z","etag":null,"topics":["cli","groq","python"],"latest_commit_sha":null,"homepage":"https://commit-pal-pythonicforge.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pythonicforge.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-14T11:42:01.000Z","updated_at":"2025-04-15T04:20:26.000Z","dependencies_parsed_at":"2025-04-15T04:37:49.557Z","dependency_job_id":"10df1d90-a0f4-45f5-a305-e8dfca3119a3","html_url":"https://github.com/pythonicforge/CommitPal","commit_stats":null,"previous_names":["pythonicforge/commitpal"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonicforge%2FCommitPal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonicforge%2FCommitPal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonicforge%2FCommitPal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonicforge%2FCommitPal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pythonicforge","download_url":"https://codeload.github.com/pythonicforge/CommitPal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249144076,"owners_count":21219960,"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","groq","python"],"created_at":"2025-04-15T19:48:17.160Z","updated_at":"2025-04-15T19:48:19.987Z","avatar_url":"https://github.com/pythonicforge.png","language":"TypeScript","readme":"# CommitPal\n🦾 **Your AI-powered terminal buddy for writing smart, stylish, and crystal-clear Git commit messages.**\n\nCommitPal is a command-line tool designed to simplify your Git workflow by generating professional, concise, and meaningful commit messages. It leverages AI to analyze your `git diff` output and create commit messages that adhere to conventional commit standards. Additionally, it supports changelog generation and automates Git operations like staging, committing, and pushing changes.\n\n\u003cbr/\u003e\n\n### Features\n- **AI-Powered Commit Messages**: Generates concise and meaningful commit messages based on your `git diff` output.\n- **Changelog Generation**: Automatically creates changelog entries for your changes.\n- **Git Automation**: Supports staging, committing, and pushing changes with a single command.\n- **Interactive Shell**: Provides an interactive shell for executing commands.\n- **Customizable Templates**: Uses a structured template for commit messages to ensure consistency.\n\n\u003cbr/\u003e\n\n### Installation\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/pythonicforge/CommitPal.git\n   ```\n2. Navigate to the project directory:\n   ```bash\n   cd CommitPal\n   ```\n3. Install dependencies:\n   ```bash\n   pip install -r requirements.txt\n   ```\n4. Set up your environment variables:\n   - Create a `.env` file in the root directory.\n   - Add your API key for the AI model:\n     ```\n     GROQ_API_KEY=your_api_key_here\n     ```\n\n\u003cbr/\u003e\n\n### Usage\nRun the tool by executing the following command:\n```bash\npython main.py\n```\n\n#### Interactive Shell Commands\n- **`diff`**: Generate a commit message based on the current `git diff`.\n  ```bash\n  diff [--changelog] [--auto-push]\n  ```\n  - `--changelog`: Generate a changelog entry for the changes.\n  - `--auto-push`: Automatically stage, commit, and push the changes to GitHub.\n\n- **`clear`**: Clear the terminal screen.\n  ```bash\n  clear\n  ```\n\n- **`bye`**: Exit the interactive shell.\n  ```bash\n  bye\n  ```\n\n\u003cbr/\u003e\n\n### Example Workflow\n1. Start the interactive shell:\n   ```bash\n   python main.py\n   ```\n2. Generate a commit message:\n   ```bash\n   (comitpal) diff\n   ```\n   Output:\n   ```\n   feat(utils): add support for changelog generation\n   ```\n3. Generate a changelog and push changes:\n   ```bash\n   (comitpal) diff --changelog --auto-push\n   ```\n\n\u003cbr/\u003e\n\n### File Structure\n```\ncomitpal/\n├── cli/\n│   └── shell.py          # Interactive shell implementation\n├── utils/\n│   ├── __init__.py       # Utility module initialization\n│   ├── log_manager.py    # Logger setup\n│   ├── services.py       # Core services (commit message generation, changelog, etc.)\n├── changelogs/\n│   └── changelog.md      # Auto-generated changelog entries\n├── main.py               # Entry point for the application\n└── README.md             # Project documentation\n```\n\n\u003cbr/\u003e\n\n### How It Works\n1. **Commit Message Generation**:\n   - Parses the `git diff` output.\n   - Uses an AI model (e.g., `gemma2-9b-it`) to generate a commit message based on a predefined template:\n     ```\n     \u003ctype\u003e(\u003cscope\u003e): \u003cshort description\u003e\n     ```\n   - Example:\n     ```\n     feat(cli): add support for auto-push flag\n     ```\n\n2. **Changelog Generation**:\n   - Creates a changelog entry based on the `git diff` output.\n   - Appends the entry to `changelogs/changelog.md`.\n\n3. **Git Automation**:\n   - Stages all changes (`git add .`).\n   - Commits changes with the generated commit message.\n   - Pushes changes to the remote repository.\n\n\u003cbr/\u003e\n\n### Contributing\nContributions are welcome! Feel free to open issues or submit pull requests to improve ComitPal.\n\n\u003cbr/\u003e\n\n### License\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonicforge%2Fcommitpal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpythonicforge%2Fcommitpal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonicforge%2Fcommitpal/lists"}