Last Updated: Oct 2, 2017

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

The Legacy Globus CLI is documented here. We strongly recommend that users move to the new CLI and not use the Legacy CLI.


Before you begin, you’ll need to install the Globus CLI. Installing the globus-cli python packge will provide you with the globus command, which will be used throughout this documentation.

Getting Started

Most CLI commands will require authentication to Globus services, so start out by getting logged in:

$ globus login
# follow instructions to get setup

You can check that you can correctly authenticate to the Globus APIs with two quick commands.

First, check that you can access Globus Auth:

$ globus get-identities ''
ID                                   | Full Name      | Username        | Organization | Email Address
------------------------------------ | -------------- | --------------- | ------------ | ------------------
c699d42e-d274-11e5-bf75-1fc5bf53bb24 | | | Globus       |

Your output should be the same as above. If you are not authenticated, you will see a message similar to:

$ globus get-identities ''
Globus CLI Error: No Authentication provided. Make sure you have logged in with globus login.

Next, check that you can reach the Globus Transfer API:

# --filter-owner-id is the ID of '', fetched above
$ globus endpoint search 'Globus Tutorial Endpoint' \
    --filter-owner-id 'c699d42e-d274-11e5-bf75-1fc5bf53bb24'
Owner           | ID                                   | Display Name
--------------- | ------------------------------------ | --------------------------- | ddb59aef-6d04-11e5-ba46-22000b92c6ec | Globus Tutorial Endpoint 1 | ddb59af0-6d04-11e5-ba46-22000b92c6ec | Globus Tutorial Endpoint 2 | cf9bcaa5-6d04-11e5-ba46-22000b92c6ec | Globus S3 Tutorial Endpoint

If you are not authenticated, you will get an error like the following:

$ globus endpoint search 'Globus Tutorial Endpoint' \
    --filter-owner-id 'c699d42e-d274-11e5-bf75-1fc5bf53bb24'
Globus CLI Error: No Authentication provided. Make sure you have logged in with globus login.

Now we have the endpoint IDs for the tutorial endpoints, and can do a test directory listing:

$ globus ls 'ddb59aef-6d04-11e5-ba46-22000b92c6ec:/'
not shareable

Start exploring the CLI!

Getting Help and Documentation

Full reference documentation for all CLI commands is available on our documentation site.

You can also view help for any command while using the CLI by passing the --help flag to that command. That will show you any subcommands and options supported by that command.

You can also use globus list-commands to see all of the commands in the CLI, and then, to get more detailed help for a specific information on a command, run that command with the --help flag.

Globus CLI Examples

In addition to the complete documentation available, we have some examples of simple and common tasks as performed using the CLI. See Examples Page.

© 2010- The University of Chicago Legal