https://github.com/margual56/gg
An opinionated, zero-friction Git collaborator that handles the "weird shit" for you. Auto-conventional commits, smart-syncing unrelated histories via rebase, and intelligent SSH/Agent authentication.
https://github.com/margual56/gg
cli cli-app git git-wrapper libgit2 rust
Last synced: 26 days ago
JSON representation
An opinionated, zero-friction Git collaborator that handles the "weird shit" for you. Auto-conventional commits, smart-syncing unrelated histories via rebase, and intelligent SSH/Agent authentication.
- Host: GitHub
- URL: https://github.com/margual56/gg
- Owner: margual56
- License: gpl-3.0
- Created: 2026-01-29T16:55:20.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-01-29T22:45:18.000Z (about 1 month ago)
- Last Synced: 2026-01-30T05:17:47.468Z (about 1 month ago)
- Topics: cli, cli-app, git, git-wrapper, libgit2, rust
- Language: Rust
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gg 🦀
**gg** is a high-level Git workflow automation tool written in Rust. It’s designed for developers who want the power of Git without the cognitive overhead of managing rebases, upstream tracking, or conventional commit formatting manually.
## ✨ Features
- **Intuitive Remotes**: `gg remote ` doesn't just set a string; it fetches, tracks, and automatically rebases unrelated histories (perfect for syncing local-first projects with new GitHub repos).
- **Smart Saving**: `gg save` analyzes your diffs to generate **Conventional Commits** (e.g., `feat(main.rs): added file`) automatically.
- **Fail-Fast Safety**: Prevents destructive operations if your working directory is dirty.
- **Automated Workflows**:
- `feature`: Syncs main, branches out, and sets up tracking in one go.
- `done`: Merges, cleans up, and returns you to safety.
- **Smart Auth**: Transparently handles SSH Agents, disk-based SSH keys (`RSA`, `ED25519`), and HTTPS Credential Helpers.
## Workflow
```mermaid
graph TD
Start((Start)) --> Creds["gg creds
Set identity"]
Creds --> Remote["gg remote
Link & Sync history"]
Remote --> Main[Main Branch]
Main --> Feature["gg feature
Branch out"]
Feature --> Code[Edit Files]
Code --> Save["gg save
Auto-commit & Push"]
Save -- "Still working?" --> Code
Save -- "Review?" --> PR["gg pr --open
Open Pull Request"]
PR --> Done
Save -- "Finished?" --> Done["gg done
Merge & Clean up"]
Done --> Main
%% Error Handling
Save -. "Conflict" .-> Fix[Manual Fix]
Fix -. "Retry" .-> Save
style Creds fill:#f5f5f5,stroke:#333
style Remote fill:#f5f5f5,stroke:#333
style Save fill:#bbf,stroke:#333
style PR fill:#ff9,stroke:#333
style Done fill:#bfb,stroke:#333
style Fix fill:#f66,stroke:#333
```
## 🚀 Quick Start
### 1. Configure your identity
```bash
gg creds "Your Name" "email@example.com" --global
```
2. Start a project and link it
Instead of fighting with --allow-unrelated-histories:
```bash
git init
gg save -m "Initial work"
gg remote git@github.com:user/repo.git
```
3. Save your work
```bash
# Automatically generates: feat: added 3 files (+12, -0, ~0)
gg save
# Or see what it would do:
gg save --dry-run
```
4. Create a Pull Request
```bash
# Output the link to stdout
gg pr
# Or open it directly in your browser
gg pr --open
```
🛠 Commands
|Command|Description|
|---|---|
|pull|Pulls from the remote|
|push|Pushes to the remote|
|features|Lists all branches|
|feature -n |Pulls latest, switches to a new branch, and pushes upstream.|
|save [-m msg]|Pulls, stages all, commits (auto-conventional), and pushes.|
|pr [--open]|Generates - and optionally opens - a link to create a PR on the appropriate service, if any|
|done [--no-clean]|Switches to main, pulls, and deletes the feature branch.|
|remote |Sets remote and performs an auto-rebase sync of histories.|
|config |Sets Git user.name and user.email.|
## 🧠 How the Auto-Sync Works
When you run gg remote, the tool performs a specialized sync:
1. It fetches the remote state.
2. It detects if the local and remote histories are unrelated.
3. It rebases your local commits onto the remote's HEAD.
4. It sets up upstream tracking so you never have to type git push -u origin main again.
GPLv3