A command line tool to automatically create pull requests on GitHub
Project description
jit
jit is a command-line tool designed to automate the process of creating pull requests for your projects. It integrates with git, and GitHub CLI and leverages local language models to generate meaningful PR descriptions based on your commits and diffs.
Features
- Automated PR Creation: Automatically generates PR description, and creates PR on GitHub.
Prerequisites
- Python 3.11 or higher
- Github CLI
Installation
pip install jit-cli
Usage
Once jit is installed, you need to download the LLM model.
jit pull-model
NOTE: The current model (llama3) is about ~4.7GB, so this step will take some time
Creating Pull Requests
To create a pull request (draft) for the current branch:
jit push
To skip the draft stage and create a live pull request, use the --skip-draft
flag:
jit push --skip-draft
Viewing Welcome Message
To view the welcome message and get started:
jit welcome
Uninstallation
pip uninstall jit-cli
Roadmap
-
Add mark as draft featureMark PRs as draft by default and add flag to bypass 📝 - Add PR template compatibility 🧑🍳
- Make installable using a package manger (no more cloning 🎉)
- Add tests 🧪
- More to come! 🏃
Contributing
Contributions to jit are welcome! Please refer to the CONTRIBUTING.md file for more details on how to submit pull requests, report issues, or make feature suggestions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jit-cli-0.1.2.tar.gz
.
File metadata
- Download URL: jit-cli-0.1.2.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe408370ac955fbfa853f48bda286b14aae6a353b372a0f055ee3fe920b841b2 |
|
MD5 | 347334a49c4837a798d9069a151d65d5 |
|
BLAKE2b-256 | 1f3c2263f0b3d6813d95b1f0f632f319fcec0387bec3c0c13820ddcdf801ddf1 |
File details
Details for the file jit_cli-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: jit_cli-0.1.2-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fe6c802445c540ae9f2498f2491649dcd22a27d19f4711f937303443716033e |
|
MD5 | 650f25a41fd84445baef084070b15efd |
|
BLAKE2b-256 | d94fe7b4cb0a82d94938ad2a061927b96824406069508aec70e1eaf31fdcfdd1 |