2 releases
new 0.2.1 | Mar 7, 2025 |
---|---|
0.2.0 | Mar 2, 2025 |
#71 in Testing
206 downloads per month
3.5MB
1.5K
SLoC
bgit: One command for most of git
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
.
Features
- 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.
Installation
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.
-
Run
cargo install bgit
Getting Started
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:
bgit
Follow 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.
How it works?
If you're interested in finding how bgit works, take a look at ARCHITECTURE.md.
Contributing
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.
License
bgit is licensed under the MIT License. See the LICENSE file for details.
Disclaimer
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.
Dependencies
~13–22MB
~358K SLoC