Skip to content

Installation

Getting started with Hug SCM is straightforward.

It's designed to be installed directly from its Github repository, and doesn't require root privileges.

Prerequisites

  • Git: Hug requires an underlying SCM tool. Currently, it only works with Git, so you must have Git installed and available in your PATH.
  • Bash shell

Installation Steps

  1. Clone the Repository

    First, clone the Hug SCM repository to a permanent location on your local machine. A common choice is your home directory.

    shell
    cd $HOME # or any other directory
    git clone https://github.com/elifarley/hug-scm.git
  2. Run the Installer

    shell
    $HOME/hug-scm/install.sh

hug will be available for any future terminal sessions you open.

  1. Activate Hug

    For the hug command to be immediately available in your current terminal session, you need to activate it. Just follow the installer instructions to do so.

    Alternatively, you can simply open a new terminal window.

  2. Verify the Installation

    You're all set! To confirm that Hug is installed correctly, run the status command.

    shell
    hug s

    You can also see a list of all available command families by running:

    shell
    hug help

You are now ready to use Hug SCM in any of your Git repositories.

Released under the Apache 2.0 License.