Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxbolgarin/gitbasher
Bash scripts for easy git from the command line
https://github.com/maxbolgarin/gitbasher
bash cli developer-tools git makefile utility
Last synced: 12 days ago
JSON representation
Bash scripts for easy git from the command line
- Host: GitHub
- URL: https://github.com/maxbolgarin/gitbasher
- Owner: maxbolgarin
- License: mit
- Created: 2023-02-12T10:53:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-19T09:48:10.000Z (3 months ago)
- Last Synced: 2024-10-19T11:01:13.699Z (3 months ago)
- Topics: bash, cli, developer-tools, git, makefile, utility
- Language: Shell
- Homepage:
- Size: 900 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitbasher
[](https://github.com/maxbolgarin/gitbasher/releases/latest)
[](https://github.com/maxbolgarin/gitbasher/blob/master/LICENSE)
[](https://github.com/maxbolgarin/gitbasher/actions)
---
> Simple **bash** utility that makes **git** easy to use
With **gitbasher** usage of `git` becomes more simple and intuitive. It helps speeding up the development process, making it more consistent reducing mistakes. This is a wrapper around the most used git commands with a cleaner interface. It uses `bash` `git` `sed` `grep` and some built-in utilities.
### Installation
```
GITB_PATH=/usr/local/bin/gitb && \
curl -SL https://raw.githubusercontent.com/maxbolgarin/gitbasher/main/dist/gitb -o $GITB_PATH && \
chmod +x $GITB_PATH
```
In Windows use `wsl` (enter `wsl` in terminal, [read more](https://learn.microsoft.com/en-us/windows/wsl/setup/environment)) to enable Linux environment. Directory `/usr/local/bin/` is not mandatory. If you get `Permission denied`, use `sudo` or put it to `~/.local/bin` with adding it to `PATH` ([how](https://discussions.apple.com/thread/254226896)).
## Getting Started
- [Why you should try this](#why-you-should-try-this)
- [How to start](#how-to-start)
- [Examples](#examples)
- [Documentation](#documentation)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
## Why you should try this
**gitbasher** is essential if you use `git` on the daily basis. Benefits you will get:
* Development process will be faster because you will spend almost no time on git
* No need to remember/google the exact names of commands and their parameters
* Making "advanced" commands like `git rebase` more user-friendly, so you will be able to unleash the full potential of the git system without any particular difficulties
* Following the [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) in the development process by simplifying the work with branches
* Making the development process clearer by using conventional commits; **gitbasher** uses [Conventional style of commits](https://www.conventionalcommits.org/en) ([example](https://gist.github.com/brianclements/841ea7bffdb01346392c))
## How to start
Just [install](#installation) gitbasher and use it in any git repository - run `gitb` in the terminal. It requires bash version 4 or higher and set remote in the repository.
Usage `gitb `
* `gitb c` for commit creation
* `gitb b n` for branch creation
* `gitb pu` for pulling from the remote
* `gitb p` for pushing to the remote
Use `gitb c help` to get help about commit commands. You can get help with `help` for all other commands. To get a global help enter `gitb`. You can find all commands description in the [documentation](#documentation).
## Examples
#### Commit: [`gitb c`](#gitb-commit-mode)
* Select files to commit and create a message in the format: `type(scope): message`
* There are a lot of modes for commit creation, e.g. `--amend` `--fixup` `revert` `push` after commit
* For example, a single `gitb c p` replaces 4 commands:
```bash
git status
git add ...
git commit -m "..."
git push
```
#### Push: [`gitb p`](#gitb-push-mode)
* Print a list of unpushed commits, push them to the current remote branch or pull changes first
* Avoid calling `git push ... -> git pull ... -> git push ...` if there are unpulled changes in branch, `gitb push` handles such changes in a single call
#### Pull: [`gitb pu`](#gitb-pull-mode)
* Fetch current branch and then ff/merge/rebase changes with conflicts fixing
* You can choose `merge` or `rebase` mode if fast-forward is not possible
* For example, you can avoid starting a merge due to an accidental call of `git pull origin master` while being in another branch
#### Branch: [`gitb b`](#gitb-branch-mode)
* With `gitb b` you can select a branch to switch from a list, it may be helpful if you don't remember the name of the branch
* With `gitb b nd` you can create a new branch from the default one with latest changes. It replaces these commands:
```
git switch main
git pull origin main
git switch -c ...
```
#### Tags: [`gitb t`](#gitb-tag-mode)
* With `gitb t` you can create a new tag from a current commit and push it to a remote
* Full tag managment: creation, fetching, pushing, deleting
#### Merge: [`gitb m`](#gitb-merge-mode)
* Select branch to merge into the current one and fix conflicts
* Create a merge commit after merging
#### Rebase: [`gitb r`](#gitb-rebase-mode)
* Rebase branch with pretty conflict fixing without infinite writing of `git rebase --continue`
* Select a commit to rebase with autosquash, it is very helpful to make a commit history better
#### Reset: [`gitb res`](#gitb-reset-mode)
* Undo commits and actions in the fast way
## Documentation
### Available commands
| Command | Short aliases | Description |
|---------------------------------|---------------------|------------------------------------------|
| [**commit**](#gitb-commit-mode) | `c` `co` `com` | Everything about commit creation |
| [**push**](#gitb-push-mode) | `p` `ps` `ph` | Pushing changes to a remote repository |
| [**pull**](#gitb-pull-mode) | `pu` `pl` `pul` | Pulling changes from a remote repository |
| [**branch**](#gitb-branch-mode) | `b` `br` `bran` | Managing branches |
| [**tag**](#gitb-tag-mode) | `t` `tg` | Managing tags |
| [**merge**](#gitb-merge-mode) | `m` `me` | Merge changes to the current branch |
| [**rebase**](#gitb-rebase-mode) | `r` `re` `base` | Rebase current branch |
| [**reset**](#gitb-reset-mode) | `res` | Easy to use git reset |
| [**config**](#gitb-config-mode) | `cf` `cfg` `conf` | Configurate gitbasher |
| **status** | `s` `st` | Info about repo and changed files |
| **log** | `l` `lg` | Open git log in a pretty format |
| **reflog** | `rl` `rlg` | Open git reflog in a pretty format |
| **help** | `h` `man` | Show help |
### `gitb commit `
| **Mode** | **Short** | **Description** |
|------------|--------------|--------------------------------------------------------------------------------------------------|
| `` | | Select files to commit and create a conventional message in format: `type(scope): message` |
| `msg` | `m` | Same as ``, but create multiline commit message using text editor |
| `ticket` | `t` | Same as ``, but add tracker's ticket info to the end of the commit header |
| `fast` | `f` | Add all files (`git add .`) and create a conventional commit message without scope |
| `fasts` | `fs` | Add all files (`git add .`) and create a conventional commit message with scope |
| `push` | `pu` `p` | Create a conventional commit and push changes at the end |
| `fastp` | `fp` | Create a conventional commit in the fast mode and push changes |
| `fastsp` | `fsp` `fps` | Create a conventional commit in the fast mode with scope and push changes |
| `fixup` | `fix` `x` | Select files and commit to make a `--fixup` commit (`git commit --fixup `) |
| `fixupp` | `fixp` `xp` | Select files and commit to make a `--fixup` commit and push changes |
| `fastfix` | `fx` | Add all files (`git add .`) and commit to make a `--fixup` commit |
| `fastfixp` | `fxp` | Add all files (`git add .`) and commit to make a `--fixup` commit and push changes |
| `amend` | `am` `a` | Select files and add them to the last commit without message edit (`git commit --amend --no-edit`) |
| `amendf` | `amf` `af` | Add all fiels to the last commit without message edit (`git commit --amend --no-edit`) |
| `last` | `l` | Change commit message to the last one |
| `revert` | `rev` | Select a commit to revert (`git revert -no-edit `) |
| `help` | `h` | Show this help |
### `gitb push `
| **Mode** | **Short** | **Description** |
|-----------|-----------|--------------------------------------------------------------------------|
| `` | | Print list of commits, push them to current branch or pull changes first |
| `yes` | `y` | Same as `` but without pressing 'y' |
| `force` | `f` | Same as `` but with --force |
| `list` | `log` `l` | Print a list of unpushed local commits without actual pushing it |
| `help` | `h` | Show this help |
### `gitb pull `
| **Mode** | **Short** | **Description** |
|---------------|------------|------------------------------------------------------------------------------|
| `` | | Fetch current branch, try to fast-forward or ask about strategy |
| `fetch` | `fe` | Fetch current branch without merge |
| `all` | `fa` | Fetch all without merge |
| `upd` | `u` | Run git remote update to fetch all branches |
| `ffonly` | `ff` | Fetch and then merge in fast forward only mode |
| `merge` | `m` | Fetch current branch and then merge it |
| `rebase` | `r` | Fetch current branch and then rebase |
| `interactive` | `ri` `rs` | Fetch current branch and then rebase in interactive mode with `--autosquash` |
| `help` | `h` | Show this help |
### `gitb branch `
| **Mode** | **Short** | **Description** |
|-----------|------------|--------------------------------------------------------------------------|
| `` | | Select a local branch to switch |
| `list` | `l` | Print a list of local branches |
| `remote` | `re` `r` | Fetch origin and select a remote branch to switch |
| `main` | `def` `m` | Switch to main without additional confirmations |
| `new` | `n` `c` | Build a conventional name and create a new branch from main |
| `newd` | `nd` | Build a conventional name, switch to main, pull it and create new branch |
| `delete` | `del` `d` | Select a local branch to delete |
| `help` | `h` | Show this help |
### `gitb tag `
| **Mode** | **Short** | **Description** |
|--------------|-----------------|---------------------------------------------------------|
| `` | | Create a new tag from the last commit |
| `annotated` | `a` `an` | Create a new annotated tag from the last commit |
| `commit` | `c` `co` `cm` | Create a new tag from a selected commit |
| `all` | `al` | Create a new annotated tag from a selected commit |
| `push` | `ps` `ph` `p` | Select a local tag and push it to the remote repository |
| `push-all` | `pa` | Push all tags to the remote repository |
| `delete` | `del` `d` | Select a tag to delete |
| `delete-all` | `da` | Delete all local tags |
| `list` | `log` `l` | Print a list of local tags |
| `remote` | `fetch` `r` | Fetch tags from the remote repository and print it |
| `help` | `h` | Show this help |
### `gitb merge `
| **Mode** | **Short** | **Description** |
|-----------|-----------|-----------------------------------------------------------------|
| `` | | Select a branch to merge into the current one and fix conflicts |
| `main` | `m` | Merge main to the current branch and fix conflicts |
| `to-main` | `tm` | Switch to main and merge the current branch into main |
| `help` | `h` | Show this help |
### `gitb rebase `
| **Mode** | **Short** | **Description** |
|---------------|---------------------|-------------------------------------------------------------------------------|
| `` | | Select base branch to rebase current changes |
| `main` | `m` | Rebase current branch onto default branch |
| `interactive` | `i` | Select base commit in current branch and rebase in an interactive mode |
| `autosquash` | `a` `s` `f` `ia` | Rebase on the current local branch in an interactive mode with `--autosquash` |
| `help` | `h` | Show this help |
### `gitb reset `
| **Mode** | **Short** | **Description** |
|---------------|-----------|-------------------------------------------------------------------------|
| `` | | Reset last commit (git reset HEAD^ --mixed) |
| `soft` | `s` | Reset last commit, but remain all fiels staged (git reset HEAD^ --soft) |
| `undo` | `u` | Undo last commit reset (git reset HEAD@{1}) |
| `interactive` | `i` | Select a commit to reset |
| `ref` | `r` | Select a HEAD reference to reset |
| `help` | `h` | Show this help |
### `gitb config `
| **Mode** | **Short** | **Description** |
|-------------|-------------------------|-------------------------------------------------------------|
| `` | | Print current gitbasher configuration |
| `user` | `u` `name` `email` | Set user name and email |
| `default` | `def` `d` `b` `main` | Update gitbasher's default branch (not in remote git repo!) |
| `separator` | `sep` `s` | Update separator between type and name in branch |
| `editor` | `ed` `e` | Update text editor for the commit messages |
| `ticket` | `ti` `t` `jira` | Set ticket prefix to help with commit/branch building |
| `scopes` | `sc` `s` | Set a list of scopes to help with commit building |
| `delete` | `unset` `del` | Unset global configuration |
## Troubleshooting
Most likely, if you have Linux, the necessary software is already installed on your machine. On MacOS, there is an outdated `bash` and there may be no `git` by default, so you should use `homebrew` to install it. On Windows you should use `wsl`, it will create a Linux environment for you with all necessary software.
#### Requirements
* `bash` version from 4.0
* Debian-based: `apt install --only-upgrade bash`
* MacOS: `brew install bash`
* `git` version from 2.23
* Debian-based: `git --version || apt install git`
* MacOS: `git --version || brew install git`
#### Uninstall
```
sudo rm /usr/local/bin/gitb
```
## Contributing
If you'd like to contribute to **gitbasher**, make a fork and submit a pull request. You also can open an issue or text me on Telegram: https://t.me/maxbolgarin
#### Scopes
Here are the possible values for `` in a commit message header. Use only these values when making commits in this repository (use no scope for global changes):
| **Scope** | **Description** |
|--------------|---------------------------------------------------------------------------------|
| **commit** | Changes mainly in `commit.sh` script, related to commit features and fixes |
| **push** | Changes mainly in `push.sh` script, related to push features and fixes |
| **pull** | Changes mainly in `pull.sh` script, related to pull features and fixes |
| **merge** | Changes mainly in `merge.sh` script, related to merge features and fixes |
| **rebase** | Changes mainly in `rebase.sh` script, related to rebase features and fixes |
| **branch** | Changes mainly in `branch.sh` script, related to branching features and fixes |
| **tag** | Changes mainly in `tag.sh` script, related to tag features and fixes |
| **reset** | Changes mainly in `reset.sh` script, related to reset features and fixes |
| **config** | Changes mainly in `config.sh` script, related to config features and fixes |
#### Maintainers
* [maxbolgarin](https://github.com/maxbolgarin)
#### License
The source code license is MIT, as described in the [LICENSE](./LICENSE) file.