The Globus CLI is maintained as a python package, built on the Globus Python SDK.

Like the SDK, it therefore requires Python 2.7+ or 3.4+.

It also requires the pip Python package manager.

Finally, installing the CLI will require that you ensure that the directory used for pip --user installations is part of your shell’s PATH variable.

Python

If a supported version of Python is not already installed, you will have to install one.

You can go directly to the python.org Download Page to get the latest python installer for your operating system.

If you want a more guided approach or are having trouble, we recommend this Python installation guide.

Warning:

macOS-provided Python has known issues

Although macOS will provide you with a working Python interpreter by default, it is known to cause issues with many Python applications, including the Globus CLI.

We strongly recommend that you follow the Python 3 installation guide instructions and do not use the OS-provided Python version.

Pip

Check if Pip is Installed

Many new versions of Python will automatically install pip.

You can quickly check if you have it installed by running

pip --version

and seeing if you get version information or a "command not found" error.

Install Pip

If you don’t have it, then try these three solutions, in order.

  1. Use a package manager

    If you’re already using a package manager like apt, yum, choco, or brew, you should install pip via that package manager. If you don’t recognize any of these terms, that’s okay — proceed to the steps below.

    Note:You may need to run the following commands with sudo if you are modifying your system python.
  2. Use ensurepip

    Try to bootstrap pip from the standard library:

    python -m ensurepip --default-pip

    And check again if you now can run pip --version.

  3. Use get-pip.py

    Download get-pip.py and run

    python get-pip.py

Add pip --user installs to your PATH

The final requirement for installing the CLI is that you add the pip --user install directory to your shell’s PATH variable.

These instructions are relevant on Linux and macOS. On Windows, no action should be necessary — pip --user installs are in your PATH by default.

Note:

The commands given below assume that you are using bash and add lines to your "$HOME/.bashrc". If you use another shell, you will have to specify your shell’s initialization file instead.

Modify your PATH variable (Linux, macOS, *nix)

On Linux and macOS, you need to make sure that the install directory for the CLI is in your PATH. This is usually ~/.local/bin, and you can run the following commands:

GLOBUS_CLI_INSTALL_DIR="$(python -c 'import site; print(site.USER_BASE)')/bin"
echo "GLOBUS_CLI_INSTALL_DIR=$GLOBUS_CLI_INSTALL_DIR"

export PATH="$GLOBUS_CLI_INSTALL_DIR:$PATH"
echo 'export PATH="'"$GLOBUS_CLI_INSTALL_DIR"':$PATH"' >> "$HOME/.bashrc"

© 2010- The University of Chicago Legal