Skip to main content

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

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 feature Mark 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jit-cli-0.1.2.tar.gz (10.2 kB view hashes)

Uploaded Source

Built Distribution

jit_cli-0.1.2-py3-none-any.whl (10.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page