Home / ubuntu / Questions / 1489246
Accepted
Abhishek Kamal
Asked: 2023-10-16 16:55:38 +0800 CST

Alias for git commands

  • 772

Most of the time, I use these git commands :

  • git add src/ package.json
  • git commit -m "custom message"
  • git push origin "name_of_the_branch"

So I want to make a single alias command which should look like:

git_alias src/ package.json && "custom message" && name_of_the_branch

By running the above alias, it should run all three git commands (add, commit and push).

How can I do this?

Note

I know that I can make alias for any command (in this case, git commit) as follows:

alias gc='git commit -m '
command-line

2 Answers

  1. Best Answer

    In this case you need to make a function. Add the following snippet to your ~/.bash_aliases:

    # Function for custom Git command (will only work for single files)
_git_commit_push() {
    git add "$1" && \
    git commit -m "$2" && \
    git push origin "$3"
}

alias gc='_git_commit_push'

    Now, when you reload your Bash config, this function and alias should be defined.

    Notice the three parameters: $1, $2 and $3. These are the command line arguments for your function. Also note that the expression && \ (logical AND plus escaping the line break) will only run the subsequent command if the first command is run.

    Now you can run your function (or the alias gc) with three arguments corresponding to the three strings (package name, custom message and name of branch). Make sure that all arguments containing spaces are enclosed in quotes, like this:

    gc "src/ package.json any_other_file" "This is my commit message" main

    You could also add some sanity checks, for instance that the files you want to add exists:
    (Now modified to accommodate multiple files as argument $1)

    # Function for custom Git command (will work for multiple files as argument $1)
_git_commit_push() {
    # Split first argument into array
    read -a filelist <<< "$1"

    # Iterate over array of files
    for file in "${filelist[@]}"
    do
        # Test if the file $file does NOT (!) exist (-e)
        if [[ ! -e "$file" ]]
        # This is what happens when the file DOES NOT exist
        then
            echo "Error: The file $file does not exist!"
            return 1 # Exit function with error code 1
        # This is what happens when the file DOES exist
        else
            git add "$file"
        fi
    done

    # Run the remaining commands to commit and push
    git commit -m "$2" && \
    git push origin "$3"
}
    • 6

  2. @arturmeinild approach is very good. If you need to keep track of more such alias or script commands, you can create a folder in /home/$USER/bin and store the commands in idividual script files.

    mkdir /home/$USER/bin
cd /home/$USER/bin
touch gc
chmod 755 gc
gedit gc

    Paste the following contents into the file

    #!/bin/bash

git add "$1" && \
git commit -m "$2" && \
git push origin "$3"

    Save andnclose the file. In your ~/.bashrc, add this line at the end if it is not already there (check for similar path export commands)

    export PATH=$PATH:/$HOME/bin

    Now you can use the gc commands anywhere. You can extend it to do anything. For example set the command fail if something is wrong in between using set -e above the commands.

    Also if you sync this folder or create the above command script file in any syncable folder, you will have this command backed up.

    • 1