Skip to content

Installation

Requirements

  • Go version 1.23 or higher.
  • Git installed and configured on your system.

Step by Step

  1. Run the installation command:

    Terminal window
    go install github.com/mr-smith-org/mr@latest
  2. Add the Go bin directory to your PATH (if it is not already included):

    Add the following line to your shell configuration file (.bashrc, .zshrc, etc.):

    Terminal window
    export PATH=$PATH:$(go env GOPATH)/bin

    Then, reload your shell or run:

    Terminal window
    source ~/.bashrc

    Replace .bashrc with your shell configuration file if necessary.

  3. Verify that $GOPATH is configured correctly:

    Run the following command to display the current value of $GOPATH:

    Terminal window
    echo $GOPATH

    Expected Results:

    • If $GOPATH is configured correctly: The command will return the path to the GOPATH directory, usually something like /home/user/go on Linux or C:Users/user/go on Windows.

    • If $GOPATH is empty or incorrect: You will need to configure it by adding the following line to your shell configuration file:

      Terminal window
      export GOPATH=$(go env GOPATH)

      Then, reload your shell or run:

      Terminal window
      source ~/.bashrc

      Replace .bashrc with your shell configuration file if necessary.

  4. Verify the installation:

    Terminal window
    mr --help

    You should see the help for the Mr. Smith CLI, confirming that the installation was successful.