CLI QuickStart Guide

Last Updated: Apr 5, 2018

Install

Before you begin, you’ll need to install the Globus CLI.

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

$ globus login
# follow instructions to get set up

Check That Login Succeeded

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 -v 'go@globusid.org'
ID                                   | Full Name      | Username        | Organization | Email Address
------------------------------------ | -------------- | --------------- | ------------ | ------------------
c699d42e-d274-11e5-bf75-1fc5bf53bb24 | www.globus.org | go@globusid.org | Globus       | noreply@globus.org

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

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

Try an Endpoint Search

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

# --filter-owner-id is the ID of 'go@globusid.org', fetched above
$ globus endpoint search 'Globus Tutorial Endpoint' \
    --filter-owner-id 'c699d42e-d274-11e5-bf75-1fc5bf53bb24'
ID                                   | Owner           | Display Name
------------------------------------ | --------------- | ---------------------------
ddb59aef-6d04-11e5-ba46-22000b92c6ec | go@globusid.org | Globus Tutorial Endpoint 1
ddb59af0-6d04-11e5-ba46-22000b92c6ec | go@globusid.org | Globus Tutorial Endpoint 2
cf9bcaa5-6d04-11e5-ba46-22000b92c6ec | go@globusid.org | 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'.

Do a Directory Listing

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

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

Explore!

Start exploring the CLI!

Try globus list-commands to see all of the commands in 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.

CLI Menu