Last Updated: Jan 13, 2021
This page provides information about the Globus CLI, a standalone application that can be installed on the user’s machine and used to access the Globus service.
The CLI provides an interface to Globus services from the shell, and is suited to both interactive and simple scripting use cases.
It is open source and available at https://github.com/globus/globus-cli
The Globus CLI is available as a python package from PyPI.
It can be installed with
We enthusiastically recommend using pipx to install the Globus CLI. It provides an isolated environment to keep your CLI installation running smoothly, and it’s resilient to changes in your system’s python installation.
pipx install globus-cli
After that, you can use
pipx to manage your installation.
Some time later, upgrade your installed version:
pipx upgrade globus-cli
Reinstall the entire CLI in the event something about your python has changed:
pipx install globus-cli --force
pip install globus-cli
This is supported anywhere that
pip works. For example, in an activated
pip install --useror
sudo pip install. There are known issues with these installation methods.
Once you install, you may want to try running through the QuickStart Guide.
Full reference documentation for all CLI commands is available on our documentation site.
You can also view help for any command by passing the
--help flag to that command.
That will show you any subcommands and options supported by that command.
globus --help to get started.
In addition to the documentation, we have some examples of simple and common tasks as performed using the CLI. See the Examples Page.