bgit is a simplified wrapper for Git, designed specifically for absolute beginners who find the Git workflow daunting. It automates common Git tasks such as adding, committing, and pushing changes, while also incorporating smart rules to prevent common issues like accidentally adding sensitive files or directories such as .env or node_modules.
- Simplified Workflow: bgit streamlines the Git workflow by guiding users through common tasks using intuitive command-line prompts.
- Smart Rules: bgit incorporates intelligent rules to prevent common mistakes, ensuring that only relevant files are added and committed.
- Extensible: Users can easily extend bgit's functionality to suit their specific needs by adding custom rules or commands.
- Complex Command Support: bgit allows users to run complex Git commands easily, abstracting away the complexities for beginners.
Warning
Windows compilation is broken, as hook_executor is not implemented yet for that platform! Fix on the way 😉
bgit is written in Rust, ensuring fast performance and reliability. To install bgit, follow these steps:
-
Ensure you have Rust installed. You can install Rust using rustup by following the instructions on rustup.rs.
-
Clone the bgit repository from GitHub:
git clone https://github.com/Gyan172004/bgit.git
-
Navigate to the bgit directory:
cd bgit -
Build bgit using Cargo:
cargo build --release
-
Once built, you can find the bgit executable in the
target/releasedirectory. You can add this directory to your PATH or move the executable to a directory already in your PATH to use bgit globally.
To start using bgit, navigate to your Git repository directory in your terminal and simply run bgit. bgit will guide you through the necessary steps to add, commit, and push your changes.
Here's a basic example of how to use bgit:
bgitFollow the on-screen prompts to add, commit, and push your changes. bgit will handle the rest, ensuring that only relevant files are included and that your Git repository remains clean and organized.
If you're interested in finding how bgit works, take a look at ARCHITECTURE.md.
Contributions to bgit are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the bgit GitHub repository.
bgit is licensed under the MIT License. See the LICENSE file for details.
Please note that while bgit aims to simplify the Git workflow for beginners, it is not a replacement for learning Git fundamentals. We encourage users to continue learning about Git to fully understand its capabilities and best practices.