GitNow

Speed up your Git workflow. 🐠

GitNow contains a command set that provides high-level operations on the top of Git.
A Fish shell alternative inspired by git-friendly.

Install

Stable:

Paket

paket add joseluisq/[email protected]

Fisher

fisher install joseluisq/[email protected]

Fundle

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

Latest changes:

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

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 or Bitbucket 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 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 file content.

Keybindings

The .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 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.

gitnow

state

Show the working tree status in compact way.

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.

# 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.

# 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.

# 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.

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.

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.

# stage && commit .
commit-all

tag

List and create release tag versions following The Semantic Versioning 2.0.0.

Show information about Tag options

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 <my tag name>
#       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.

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.

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.

# 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

tag <some tag name>

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 <branch_name>
• pull <remote_origin> <branch_name>

Manual mode:

• pull <remote_origin> <branch_name> --verbose

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...].

# Auto mode (current origin and branch)
push
# Manual mode
push <origin_name> <branch_name> <--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.

upstream

move

Switch from current branch to another but stashing uncommitted changes

Note: This command does git stash then git checkout <other_branch> and finally git stash pop (possible to disable). It also takes care that <other_branch> 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.

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 <other branch>.

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.

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

# 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) branch from current branch.

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

feature feat1
# > feature/feat1
feature "This is my New FEATURE Branch"
# > feature/this_is_my_new_feature_branch

hotfix

Creates a new hotfix (Gitflow) branch from current branch.

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

hotfix fix1
# > hotfix/fix1
hotfix "This is my New FIX Branch"
# > hotfix/this_is_my_new_fix_branch

bugfix

Creates a new bugfix (Gitflow) branch from current branch.

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

bugfix fix1
# > bugfix/fix1
bugfix "This is my New bugFIX Branch"
# > bugfix/this_is_my_new_bugfix_branch

release

Creates a new release (Gitflow) branch from current branch.

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

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.

# 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:

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:

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:

# a) GitHub
git config --global user.github "your_username"
# b) Bitbucket
git config --global user.bitbucket "your_username"

Bonus

• Git Cheat Sheet — Another Git cheat sheet yet.
• Git useful aliases — Set of useful Git aliases.
• Gitflow

Contributions

Pull requests and issues are welcome.

License

MIT license

© 2016-present Jose Quintana