Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julien040/gut
A beginner friendly porcelain for git
https://github.com/julien040/gut
cli git github go golang gut terminal version-control
Last synced: about 8 hours ago
JSON representation
A beginner friendly porcelain for git
- Host: GitHub
- URL: https://github.com/julien040/gut
- Owner: julien040
- License: mit
- Created: 2022-12-22T09:27:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T06:54:07.000Z (about 2 months ago)
- Last Synced: 2025-01-03T14:14:16.099Z (7 days ago)
- Topics: cli, git, github, go, golang, gut, terminal, version-control
- Language: Go
- Homepage: https://gut-cli.dev
- Size: 291 KB
- Stars: 484
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Gut
> ⚠️ Gut is still in alpha which means that there may be some features that are missing
>
> **To read about the [future of Gut](/future_of_gut.md), check [this blog post](/future_of_gut.md)**
Gut is an alternative CLI for Git. It provides a consistent naming of commands and a useful set of features.
If you have years of muscle memory, gut is probably not for you.
## Table of contents
- [Gut](#gut)
- [Table of contents](#table-of-contents)
- [Example](#example)
- [Features](#features)
- [Main Useful Commands](#main-useful-commands)
- [Installation](#installation)
- [Windows](#windows)
- [MacOS](#macos)
- [Apt-get](#apt-get)
- [Yum](#yum)
- [AUR (Arch Linux)](#aur-arch-linux)
- [Compile yourself](#compile-yourself)
- [Use pre-compiled binary](#use-pre-compiled-binary)
- [Build from source](#build-from-source)
- [Principles](#principles)
- [Integration with cloud](#integration-with-cloud)
- [No rewriting of history](#no-rewriting-of-history)
- [Staging area isn’t a thing](#staging-area-isnt-a-thing)
- [Detached HEAD isn’t scary](#detached-head-isnt-scary)
- [Great user experience](#great-user-experience)
- [Coexist with Git](#coexist-with-git)
- [Documentation](#documentation)
- [FAQ](#faq)
- [Why was this project built?](#why-was-this-project-built)
- [How can I contact the developer?](#how-can-i-contact-the-developer)
- [Can I contribute?](#can-i-contribute)
- [Roadmap](#roadmap)
- [License](#license)
- [Authors](#authors)
- [Contributing](#contributing)
## Example
```bash
cd my-awesome-project
# Init a new git repo
gut init
# Do some changes
touch my-billion-dollar-idea.txt
# Commit your new file
gut save # Alias of gut commit
# Sync your changes with the upstream
gut sync
```
## Features
- Built-in credentials manager
- Consistent naming of commands
- Integration with cloud platforms (merge and diff opens in the web UI)
- `gut fix` command helps you fix your mistakes with git
- `.gitignore` template downloader
- Simplified authentication with GitHub
## Main Useful Commands
- `gut save` - Commits changes using gitmoji
- `gut sync` - Syncs changes with your remote repository
- `gut goto` - Lets you rewind the state of your project to a particular commit by temporarily modifying the working tree
- `gut fix` - Helps you fix your mistakes with git
- `gut revert` - Reverts your project to a previous state to fix a bug introduced n commits ago
- `gut undo` - Discards changes made since the last commit
- `gut ignore` - Downloads templates of `.gitignore`
- `gut whereami` - Shows where your HEAD points to (no more `rev-parse`)
- `gut switch` - Creates a new branch or switches to an existing one
## Installation
### Windows
To install gut on Windows, run
```bash
scoop bucket add gut https://github.com/julien040/gut-scoop
scoop install gut/gut
```
### MacOS
To install gut on macOS, open the Terminal and run
```bash
brew tap julien040/gut && brew install gut
```
### Apt-get
```bash
echo "deb [trusted=yes] https://apt.gut-cli.dev /" | sudo tee /etc/apt/sources.list.d/gut.list
sudo apt-get update
sudo apt-get install gut
```
### Yum
```bash
sudo tee /etc/yum.repos.d/gut.repo <` to change your working tree according to that commit.
But gut won’t leave you there.
In detached HEAD, every operation is blocked until you do something with that commit. You can come back to a branch or create a new one from that commit.
By blocking operations, you won’t create several commits before realizing they aren’t linked to anything.
### Great user experience
If you make a mistake, gut will try to figure it out and prompt you again.
And if gut can’t help you, it will do its best to guide you to solve the issue.
I believe that when learning new technology, it's best to start with a high-level understanding and then gradually delve deeper over time. Specifically, when it comes to Git, I find that it can seem complex right from the beginning (such as setting `user.email` and `user.name`)
### Coexist with Git
While **`gut`** is a useful CLI tool, it's not intended to replace the **`git`** CLI. In fact, if Git were to disappear, **`gut`** would no longer function since it heavily relies on Git commands internally.
That being said, I believe that **`gut`** is an excellent choice for simple tasks, while Git can still be utilized for more complex tasks.
## Documentation
[Documentation](https://gut-cli.dev/docs)
## FAQ
### Why was this project built?
In my two years of learning how to code, I found `git` to be extremely frustrating. I was always scared of doing the wrong thing and not being able to revert it. This is why I built `gut` - so that everyone can use `git` without the headaches.
### How can I contact the developer?
To discuss a new feature you would like to see, open a new discussion on GitHub.
For a bug, open a new issue.
For anything related to security, commercial or press, send an email to [[email protected]](mailto:[email protected]).
### Can I contribute?
Of course, you can!
## Roadmap
- Create and delete tags.
- Conflict resolution.
- `gut restore` to checkout specific files.
- `gut commit sparsely` to create a commit with specified files rather than all files.
- `gut time-machine` to go back in time (e.g. reverse a pull).
- Open a new discussion if you want your feature to be added here!
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Authors
- [@julien040](https://github.com/julien040)
## Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct`.