BeforePush

A lightweight CLI that checks whether your Git branch is ready before pushing or opening a pull request.

Features

• Check if the current directory is a Git repository
• Show the current branch
• Detect uncommitted or untracked changes
• Check upstream branch configuration
• Check if the current branch is behind a target branch
• Support custom target branches
• Clean terminal output with Rich

Installation

Install BeforePush from PyPI:

pip install before-push

Usage

Run BeforePush inside a Git repository:

beforepush

By default, BeforePush checks your current branch against main.

You can specify a different target branch with --target:

beforepush --target develop

Example

Checks

BeforePush performs the following checks:

• Git repository: verifies that the current directory is a Git repository.
• Current branch: shows the branch currently checked out.
• Working tree: detects uncommitted or untracked changes.
• Upstream branch: checks whether the current branch has an upstream branch configured.
• Target branch: checks whether the current branch is behind the selected target branch.

Development

Clone the repository:

git clone https://github.com/alibro005/beforepush.git
cd beforepush

Install dependencies:

uv sync

Run the tests:

uv run pytest -v

Run the CLI locally:

uv run beforepush

Test against another target branch:

uv run beforepush --target develop

Scope

BeforePush focuses on local Git branch readiness.

It does not create or merge pull requests, authenticate with GitHub, perform code reviews, manage remote repositories, or modify Git history.

License

This project is licensed under the MIT License.