Metadata-Version: 2.1
Name: jit-cli
Version: 0.1.0
Summary: A command line tool to automatically create pull requests on GitHub
Home-page: https://github.com/gsvh/jit
Author: George S. van Heerden
Author-email: georgesebastiaan.vh@gmail.com
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: Terminals
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
License-File: LICENSE

# 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

Before installing jit, ensure you have the following installed:

- [Python](https://www.python.org/downloads/) 3.6 or higher
- `pip3` for Python package management
- [Homebrew](https://brew.sh/) (for macOS users) to install certain dependencies

The installation process will prompt you to download the following:

- [Github CLI](https://cli.github.com/)
- [Ollama](https://ollama.com/) - with the llama3 model

## Installation

Clone the repository and navigate to the project directory:

```bash
git clone https://github.com/gsvh/jit.git
cd jit
```

To install **jit**, simply run:

```bash
make setup
```

## Usage

Once **jit** is installed, you can start using it to manage your pull requests. Here’s how to get started:

### Creating Pull Requests

To create a pull request for the current branch:

```bash
jit push
```

To run in dry mode (generate PR description without creating a PR):

```bash
jit push --dry
```

### Viewing Welcome Message

To view the welcome message and get started:

```bash
jit welcome
```

### Updating jit

To update jit to the latest stable version:

```bash
jit update
```

## Uninstallation

To uninstall **jit** and optionally remove installed dependencies:

```bash
make uninstall
```

# Roadmap

- [ ] Add mark as draft feature 📝
- [ ] 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.
