Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joseluisq/gitnow

Speed up your Git workflow. :tropical_fish:
https://github.com/joseluisq/gitnow

bitbucket fish-packages fish-shell git git-workflow github keybindings semver ssh

Last synced: about 1 month ago
JSON representation

Speed up your Git workflow. :tropical_fish:

Awesome Lists containing this project

README 

        
# GitNow ![CI](https://github.com/joseluisq/gitnow/workflows/CI/badge.svg?branch=master) [![Releases](https://img.shields.io/github/release/joseluisq/gitnow.svg?label=latest)](https://github.com/joseluisq/gitnow/releases)



> Speed up your Git workflow. 🐠



GitNow contains a command set that provides high-level operations on the top of [Git](https://git-scm.com/book/en/v2). 


A [Fish shell](https://fishshell.com/) alternative inspired by [git-friendly](https://github.com/jamiew/git-friendly).



## Install



__Stable:__



[Paket](https://github.com/joseluisq/paket)



```sh

paket add joseluisq/[email protected]

```



[Fisher](https://github.com/jorgebucaran/fisher)



```sh

fisher install joseluisq/[email protected]

```



[Fundle](https://github.com/danhper/fundle)



```sh

fundle plugin joseluisq/gitnow --url '[email protected]:joseluisq/gitnow.git#tags/2.12.0'

```



__Latest changes:__



```sh

paket add joseluisq/gitnow



# Or

fisher install joseluisq/gitnow



# Or

fundle plugin joseluisq/gitnow

```



_**Note:** Use that method if you don't want to wait for a new release._



## Commands



| Command | Shortcut | Description |

|---|---|---|

| [gitnow](#gitnow) | | Show available commands and version info.

| __Git__ | | |

| [state](#state) | Alt + S | Show the working tree status in a compact way. |

| [stage](#stage) | Alt + E | Stage files in current working directory. |

| [unstage](#unstage) | Ctrl + E | Unstage files in current working directory. |

| [show](#show) | Alt + M | Show commit detail objects. |

| [untracked](#untracked) | | Check for untracked files and directories. |

| [commit](#commit) | | Commit changes to the repository. |

| [commit-all](#commit-all) | Alt + C | Add and commit all changes to the repository. |

| [tag](#tag) | | List and create release tag versions following Semver 2.0. |

| [pull](#pull) | Alt + D | Pull changes from remote server but saving uncommitted changes. |

| [push](#push) | Alt + P | Push commit changes to remote repository. |

| [upstream](#upstream) | Alt + U | Commit all changes and push them to remote server. |

| [move](#move) | | Moves from current branch to another but stashing your changes. |

| [merge](#merge) | | Merges a local branch into the active one. |

| [assume](#assume) | | Ignores changes in certain files temporarily. |

| [logs](#logs) | Alt + L | Shows logs in a fancy way. |

| __Gitflow__ | | |

| [feature](#feature) (1) | Alt + F | Creates a new _feature_ ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch. |

| [hotfix](#hotfix) (1) | Alt + H | Creates a new _hotfix_ ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch. |

| [bugfix](#bugfix) (1) | | Creates a new _bugfix_ ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch. |

| [release](#release) (1) | | Creates a new _release_ ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch. |

| __Bonus__ | | |

| [github](#github) | | Clone a _GitHub_ repository using SSH. |

| [bitbucket](#bitbucket) | | Clone a _Bitbucket Cloud_ repository using SSH. |



**Note:**



- (1) This command key binding can creates a new branch taking as name some text of the clipboard (optional).



## Tips



- Skip the password request creating a SSH key for your [Github](https://help.github.com/en/articles/connecting-to-github-with-ssh) or [Bitbucket](https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html) account.

- SSH setup is required for using `github` and `bitbucket` commands.

- Take advantage of keybindings in order to get faster operations.



## Gitnow configuration file



To configure Gitnow just copy the [.gitnow](conf.d/.gitnow) default file and place it in your home directory (`~/.gitnow`).



### Options



The **_[ options ]_** section contains some options in order to adjust centain Gitnow behaviour.



For more details about the options please take a look at [.gitnow](conf.d/.gitnow) file content.



### Keybindings



The [.gitnow](conf.d/.gitnow) file contains a **_[ keybindings ]_** section with default shortcuts (key-value pairs).

But you can add, edit or remove keybindings on demand. If you want custom keybindings for your commands just run [fish_key_reader](https://fishshell.com/docs/current/cmds/fish_key_reader.html) in your terminal, then press the key or key's combinations to get the right characters sequence and finally set it to your preferred command in your `~/.gitnow` file.



## Usage



### gitnow



Show available commands and version info.



```sh

gitnow

```



### state



Show the working tree status in compact way.



```sh

state

Current working tree status:

## master...origin/master

 M README.md

 M conf.d/gitnow.fish

```



### stage



Stage files in current working directory.



__Note:__ This command does `git add .` by default. Add your `git add` flags as usual to overwrite it.



```sh

# a) git add . (by default)

stage

# b) custom 1

stage README.md LICENSE.md

# c) custom 2

stage . --ignore-errors

```



### unstage



Unstage files in current working directory.



__Note:__ This command does `git reset .` by default. Add your `git reset` flags as usual to overwrite it.



```sh

# a) git reset . (by default)

unstage

# b) custom 1

unstage README.md LICENSE.md

# c) custom 2

unstage --soft HEAD

```



### show



Show commit detail objects.



__Note:__ This command does `git show --compact-summary HEAD` by default. Add your `git show` flags as usual to overwrite it.



```sh

# a) Default

show

# b) Custom flags

show --compact-summary HEAD~1

```



### untracked



Check for untracked files and directories that could be removed of current working directory.



__Notes:__



- This command does `git clean --dry-run -d` only.

- It doesn't remove anything, just makes a clean checking of files and directories that could be removed.

- No flags are supported.



```sh

untracked

# Would remove .file1

# Would remove dir1/

# Would remove file2

```



### commit



Commit changes to the repository.



__Note:__ This command does `git commit` only. Add your `git commit` flags as usual to overwrite it.



```sh

commit

commit README.md

commit .

commit --amend

```



### commit-all



Add and commit all changes to the repository.



__Note:__ This command does `stage` and then `commit .`. No flags supported.



```sh

# stage && commit .

commit-all

```



### tag



List and create release tag versions following [The Semantic Versioning 2.0.0](https://semver.org/).



#### Show information about Tag options



```sh

tag -h                                                                                                                                          (13s 251ms)

# NAME

#       Gitnow: tag - List or tag commits following The Semantic Versioning 2.0.0 (Semver) [1]

#       [1] https://semver.org/

# EXAMPLES

#       List tags: tag

#       Custom tag: tag 

#       Semver tag: tag --major

# OPTIONS:

#       Without options all tags are listed in a lexicographic order and tag names are treated as versions

#       -x --major         Tag auto-incrementing a major version number

#       -y --minor         Tag auto-incrementing a minor version number

#       -z --patch         Tag auto-incrementing a patch version number

#       -l --latest        Show only the latest Semver release tag version (no suffixed ones or others)

#       -h --help          Show information about the options for this command

```



#### List all available tags



Tags are listed in a lexicographic order and tag names are treated as versions.



```sh

tag

```



#### Get latest Semver release tag name



> **Note:** This option gets only the latest *Semver release version* tag name but no any suffixed version ones or another kind of version names. The same apply when you create correlative Semver tags. See next section.



```sh

tag --latest

```



#### Create Semver correlative tag names



> **Note:** Following commands take care about optional `v` prefixed tag names.

> So for example if a `v1.0.0` is found as latest major then the next correlative tag name major will be `v2.0.0`.

> Otherwise for example if a `1.0.0` is found as latest minor then the next correlative tag name minor will be `1.1.0`.



```sh

# Create a correlative Semver major tag

tag --major

# Create a correlative Semver minor tag

tag --minor

# Create a correlative Semver patch tag

tag --patch

```



#### Create custom tag names



```sh

tag 

```



### pull



Pull changes from remote server but saving uncommitted changes.



This command makes this for you:



- Save your uncommitted changes locally using `--autostash` option.

- Local changes you made will be rebased (`---rebase` option) on top of the remote changes.

- Return your uncommitted changes locally again.



__Auto mode:__



- `pull`

- `pull `

- `pull  `



__Manual mode:__



- `pull   --verbose`



```sh

pull

📥 Pulling changes

Arguments mode: Auto

Default arguments: --rebase --autostash

Remote: origin (https://github.com/joseluisq/gitnow.git)

Branch: master



From https://github.com/joseluisq/gitnow

 * branch            master     -> FETCH_HEAD

Created autostash: 473315a

HEAD is now at 9de2f93 update commands

Current branch master is up to date.

Applied autostash.

```



### push



Push commit changes to remote repository.



__Note:__ This command is equivalent to `git push --set-upstream [your arguments...]`.



```sh

# Auto mode (current origin and branch)

push

# Manual mode

push   <--some_other_flags>

```



### upstream



Commit all changes and push them to remote server.



__Note:__ This command does `commit-all` and then `push`. No flags supported.



```sh

upstream

```



### move



Switch from current branch to another but stashing uncommitted changes



__Note:__ This command does `git stash` then `git checkout ` and finally `git stash pop` (possible to disable). It also takes care that `` matches with the existing local branches.



__Additional options:__



- Use `-u` (or `--upstream`) flag to fetch a remote branch.

- Use `-n` (or `--no-apply-stash`) flag to prevent stashed changes to be applied.



```sh

move other_branch



# Branch `ghost_branch` was not found. No possible to switch.

move ghost_branch



# With -u flag the branch will be fetched from remote origin.

move -u feature/new_remote_branch



# With -n flag stashed changes will not be applied.

move -n feature/new_remote_branch



# Possible to combine two option flags

move -un feature/another_remote_branch

```



### merge



Merge a local branch into the active one



__Note:__ This command does a simple `git merge `.



__Additional options:__



- Use `-a` (or `--abort`) flag instead of a branch name to abort a conflicted merge.

- Use `-c` (or `--continue`) flag instead of a branch name to continue a merge.



```sh

merge other_branch



# Local branch ghost_branch was not found. Not possible to merge.

merge ghost_branch



# With -a flag the conflicted merge will be aborted.

merge -a

```



### assume



Ignore changes in certain files temporarily.



__Note:__ This command performs `git update-index --[no-]assume-unchanged` to ignore changes in certain files temporarily or revert those changes back.



__Options:__



- `-n` `--no-assume`: No assume unchanged files to be ignored (revert option)

- `-h` `--help`: Show information about the options for this command



```sh

# a) Ignore files temporarily

assume Cargo.toml README.md



# b) Revert file ignored changes

assume -n Cargo.toml README.md

```



### feature



Creates a new feature ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch.



__Note:__ Your new branch will always be lowercase without special characters or whitespaces (underscores instead).



```sh

feature feat1

# > feature/feat1

feature "This is my New FEATURE Branch"

# > feature/this_is_my_new_feature_branch

```



### hotfix



Creates a new hotfix ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch.



__Note:__ Your new branch will always be lowercase without special characters or whitespaces (underscores instead).



```sh

hotfix fix1

# > hotfix/fix1

hotfix "This is my New FIX Branch"

# > hotfix/this_is_my_new_fix_branch

```



### bugfix



Creates a new bugfix ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch.



__Note:__ Your new branch will always be lowercase without special characters or whitespaces (underscores instead).



```sh

bugfix fix1

# > bugfix/fix1

bugfix "This is my New bugFIX Branch"

# > bugfix/this_is_my_new_bugfix_branch

```



### release



Creates a new release ([Gitflow](https://github.com/nvie/gitflow)) branch from current branch.



__Note:__ Your new branch will always be lowercase without special characters or whitespaces (underscores instead).



```sh

release fix1

# > release/fix1

release "This is my New release Branch"

# > release/this_is_my_new_bugfix_branch

```



### logs



Shows logs in a fancy way.



__Note:__ This command does `git log HEAD` by default using a pretty format. Add your `git log` flags as usual to overwrite it.



```sh

# shows all logs (default)

logs



# shows logs using git log parameters and flags (custom)

logs 8b09088

logs --before "yesterday" --after="1 week ago"

```



### github



Clone a GitHub repository using SSH.



Examples:



```sh

github username/repo-name

github username repo-name



# requires a `user.github` username Git config entry

github repo-name

```



### bitbucket



Clone a Bitbucket Cloud repository using SSH.



Examples:



```sh

bitbucket username/repo-name

bitbucket username repo-name



# requires a `user.bitbucket` username Git config entry

bitbucket repo-name

```



__Note:__ For cloning some repo only, it's necessary to set your Github or Bitbucket username to global config before like:



```sh

# a) GitHub

git config --global user.github "your_username"

# b) Bitbucket

git config --global user.bitbucket "your_username"

```



## Bonus



- [Git Cheat Sheet](https://github.com/joseluisq/git-cheat-sheet/) — Another Git cheat sheet yet.

- [Git useful aliases](https://github.com/joseluisq/git-useful-aliases) — Set of useful Git aliases.

- [Gitflow](https://github.com/nvie/gitflow)



## Contributions



[Pull requests](https://github.com/joseluisq/gitnow/pulls) and [issues](https://github.com/joseluisq/gitnow/issues) are welcome.



## License

MIT license



© 2016-present [Jose Quintana](http://github.com/joseluisq)