Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install bgit

It will make the bgit command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall bgit uninstalls.

Back to the crate overview.

Readme

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

Quick Install precompiled Binary

Linux/macOS

curl -fsSL https://raw.githubusercontent.com/rootCircle/bgit/main/scripts/install.sh | bash

Windows (PowerShell)

iwr -useb https://raw.githubusercontent.com/rootCircle/bgit/main/scripts/install.ps1 | iex

Advanced options, supported targets, checksums/signatures, and troubleshooting are documented here:

See docs/INSTALL.md

Install via Cargo

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.

Want to try it out? Check bgit_clone_sample repository.

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.