Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.13 KB

README.md

File metadata and controls

73 lines (51 loc) · 2.13 KB
Raw

gat - Git Automation Tool

This Rust application automates the process of adding, committing, and pushing changes to a Git repository. It simplifies the workflow by handling these tasks automatically, allowing users to focus on their code changes.

Table of Contents

  1. gat - Git Automation
  2. Features
  3. Prerequisites
  4. Installation
  5. Usage
  6. Customizing Branch Name
  7. Upcoming Features

Features

  • Simplified Workflow: Automates the Git commands (git add -A, git commit -m, and git push origin main) to streamline the process.
  • Error Handling: Provides informative error messages if any Git command fails, making it easy to identify and fix issues.
  • Customizable Branch: Allows configuration of the target branch for pushing changes (default: main).

Prerequisites

  • Rust: Make sure you have Rust installed on your system.

Installation

  1. Clone the Repository:

    git clone https://github.com/fewrux/gat.git

  2. Navigate to the Project Directory:

    cd gat

  3. Build in release mode:

    cargo build --release

  4. Install the application:

    cargo install --path .

Usage

Provide your commit message as a command-line argument:

gat "Your commit message here"

Replace "Your commit message here" with your actual commit message.

Customizing Branch Name

By default, the application pushes changes to the main branch. If you want to push changes to a different branch, modify the GIT_BRANCH constant in the main.rs file.

const GIT_BRANCH: &str = "main";

Replace "main" with the name of your desired branch.

Upcoming Features

  • Branch customization through command-line argument