CLI Menu
  • Introduction
  • QuickStart
  • Collections vs Endpoints
  • High Assurance
  • Environment Variables
  • Reference
    • CLI Changelog
    • GLOBUS API AUTH
    • GLOBUS API FLOWS
    • GLOBUS API GROUPS
    • GLOBUS API SEARCH
    • GLOBUS API TIMER
    • GLOBUS API TRANSFER
    • GLOBUS BOOKMARK CREATE
    • GLOBUS BOOKMARK DELETE
    • GLOBUS BOOKMARK LIST
    • GLOBUS BOOKMARK RENAME
    • GLOBUS BOOKMARK SHOW
    • GLOBUS CLI-PROFILE-LIST
    • GLOBUS COLLECTION DELETE
    • GLOBUS COLLECTION LIST
    • GLOBUS COLLECTION SHOW
    • GLOBUS COLLECTION UPDATE
    • GLOBUS DELETE
    • GLOBUS ENDPOINT ACTIVATE
    • GLOBUS ENDPOINT DEACTIVATE
    • GLOBUS ENDPOINT DELETE
    • GLOBUS ENDPOINT IS-ACTIVATED
    • GLOBUS ENDPOINT LOCAL-ID
    • GLOBUS ENDPOINT MY-SHARED-ENDPOINT-LIST
    • GLOBUS ENDPOINT PERMISSION CREATE
    • GLOBUS ENDPOINT PERMISSION DELETE
    • GLOBUS ENDPOINT PERMISSION LIST
    • GLOBUS ENDPOINT PERMISSION SHOW
    • GLOBUS ENDPOINT PERMISSION UPDATE
    • GLOBUS ENDPOINT ROLE CREATE
    • GLOBUS ENDPOINT ROLE DELETE
    • GLOBUS ENDPOINT ROLE LIST
    • GLOBUS ENDPOINT ROLE SHOW
    • GLOBUS ENDPOINT SEARCH
    • GLOBUS ENDPOINT SERVER ADD
    • GLOBUS ENDPOINT SERVER DELETE
    • GLOBUS ENDPOINT SERVER LIST
    • GLOBUS ENDPOINT SERVER SHOW
    • GLOBUS ENDPOINT SERVER UPDATE
    • GLOBUS ENDPOINT SET-SUBSCRIPTION-ID
    • GLOBUS ENDPOINT SHOW
    • GLOBUS ENDPOINT STORAGE-GATEWAY LIST
    • GLOBUS ENDPOINT UPDATE
    • GLOBUS ENDPOINT USER-CREDENTIAL CREATE FROM-JSON
    • GLOBUS ENDPOINT USER-CREDENTIAL CREATE POSIX
    • GLOBUS ENDPOINT USER-CREDENTIAL CREATE S3
    • GLOBUS ENDPOINT USER-CREDENTIAL DELETE
    • GLOBUS ENDPOINT USER-CREDENTIAL LIST
    • GLOBUS ENDPOINT USER-CREDENTIAL SHOW
    • GLOBUS FLOWS DELETE
    • GLOBUS FLOWS LIST
    • GLOBUS FLOWS SHOW
    • GLOBUS FLOWS START
    • GLOBUS GCP CREATE GUEST
    • GLOBUS GCP CREATE MAPPED
    • GLOBUS GET-IDENTITIES
    • GLOBUS GROUP CREATE
    • GLOBUS GROUP DELETE
    • GLOBUS GROUP INVITE ACCEPT
    • GLOBUS GROUP INVITE DECLINE
    • GLOBUS GROUP JOIN
    • GLOBUS GROUP LEAVE
    • GLOBUS GROUP LIST
    • GLOBUS GROUP MEMBER ADD
    • GLOBUS GROUP MEMBER APPROVE
    • GLOBUS GROUP MEMBER INVITE
    • GLOBUS GROUP MEMBER LIST
    • GLOBUS GROUP MEMBER REJECT
    • GLOBUS GROUP MEMBER REMOVE
    • GLOBUS GROUP SET-POLICIES
    • GLOBUS GROUP SHOW
    • GLOBUS GROUP UPDATE
    • GLOBUS LIST-COMMANDS
    • GLOBUS LOGIN
    • GLOBUS LOGOUT
    • GLOBUS LS
    • GLOBUS MKDIR
    • GLOBUS RENAME
    • GLOBUS RM
    • GLOBUS SEARCH DELETE-BY-QUERY
    • GLOBUS SEARCH INDEX CREATE
    • GLOBUS SEARCH INDEX DELETE
    • GLOBUS SEARCH INDEX LIST
    • GLOBUS SEARCH INDEX ROLE CREATE
    • GLOBUS SEARCH INDEX ROLE DELETE
    • GLOBUS SEARCH INDEX ROLE LIST
    • GLOBUS SEARCH INDEX SHOW
    • GLOBUS SEARCH INGEST
    • GLOBUS SEARCH QUERY
    • GLOBUS SEARCH SUBJECT DELETE
    • GLOBUS SEARCH SUBJECT SHOW
    • GLOBUS SEARCH TASK LIST
    • GLOBUS SEARCH TASK SHOW
    • GLOBUS SESSION CONSENT
    • GLOBUS SESSION SHOW
    • GLOBUS SESSION UPDATE
    • GLOBUS TASK CANCEL
    • GLOBUS TASK EVENT-LIST
    • GLOBUS TASK GENERATE-SUBMISSION-ID
    • GLOBUS TASK LIST
    • GLOBUS TASK PAUSE-INFO
    • GLOBUS TASK SHOW
    • GLOBUS TASK UPDATE
    • GLOBUS TASK WAIT
    • GLOBUS TIMER CREATE TRANSFER
    • GLOBUS TIMER DELETE
    • GLOBUS TIMER LIST
    • GLOBUS TIMER SHOW
    • GLOBUS TRANSFER
    • GLOBUS UPDATE
    • GLOBUS VERSION
    • GLOBUS WHOAMI
  • Examples
Skip to main content
Globus Docs
  • APIs
    Auth Flows Groups Search Transfer Python SDK Helper Pages
  • How To
  • Guides
    Globus Connect Server High Assurance Collections for Protected Data Command Line Interface Premium Storage Connectors Security Modern Research Data Portal
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Introduction

Command Line Interface (CLI)

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

Installation

The Globus CLI is available as a python package from PyPI. It can be installed with pipx or pip.

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
  • pip
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 reinstall globus-cli
pip install globus-cli

This is supported anywhere that pip works. For example, in an activated virtualenv.

Note

We recommend against installing with pip install --user or sudo pip install. There are known issues with these installation methods.

Setting Up Tab Completion

The Globus CLI provides a shell completer for tab completion, supporting both the zsh and bash shells. To setup completion, you must run a shell function provided by the globus command.

The following snippets are suitable for inclusion in a .bashrc or .zshrc, to setup completion whenever a shell starts and the Globus CLI is installed:

  • bash
  • zsh
  • autodetect
if type globus > /dev/null 2>&1; then
    eval "$(globus --bash-completer)"
fi
Note

The completer requires Bash version 4.4 or newer. If you are using an older version of Bash, you may have success writing the completer to a file and editing it, e.g.

globus --bash-completer | sed 's/nosort/nospace/' > ~/.globus_bash_completion.sh

and then sourcing it in your .bashrc.

if type globus > /dev/null 2>&1; then
    eval "$(globus --zsh-completer)"
fi

The --completer flag can be used in either bash or zsh. It will detect your current shell from the SHELL environment variable. You can use it if you use multiple shells and want to share config:

if type globus > /dev/null 2>&1; then
    eval "$(globus --completer)"
fi

If you are wary of putting a subshell invocation inside of eval, consider redirecting the output to a file, reading the file to see what it does, and then sourcing it.

Note that we recommend checking for changes whenever upgrading the CLI if you use this approach, as we may modify the output of the completer to fix bugs and issues.

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 by passing the --help flag to that command. That will show you any subcommands and options supported by that command.

Try globus --help to get started.

Documentation Topics

Other useful pieces of documentation include…​

QuickStart Guide

Once you install, you may want to try running through the QuickStart to see basic login and usage info.

Environment Variables

Environment variables with special meanings to the Globus CLI.

Collection vs Endpoint Handling

How the Globus CLI handles the distinction between Collections and Endpoints.

Reference Documentation

A complete reference to all Globus CLI commands.

Usage Examples

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

  • Introduction
  • QuickStart
  • Collections vs Endpoints
  • High Assurance
  • Environment Variables
  • Reference
    • CLI Changelog
    • GLOBUS API AUTH
    • GLOBUS API FLOWS
    • GLOBUS API GROUPS
    • GLOBUS API SEARCH
    • GLOBUS API TIMER
    • GLOBUS API TRANSFER
    • GLOBUS BOOKMARK CREATE
    • GLOBUS BOOKMARK DELETE
    • GLOBUS BOOKMARK LIST
    • GLOBUS BOOKMARK RENAME
    • GLOBUS BOOKMARK SHOW
    • GLOBUS CLI-PROFILE-LIST
    • GLOBUS COLLECTION DELETE
    • GLOBUS COLLECTION LIST
    • GLOBUS COLLECTION SHOW
    • GLOBUS COLLECTION UPDATE
    • GLOBUS DELETE
    • GLOBUS ENDPOINT ACTIVATE
    • GLOBUS ENDPOINT DEACTIVATE
    • GLOBUS ENDPOINT DELETE
    • GLOBUS ENDPOINT IS-ACTIVATED
    • GLOBUS ENDPOINT LOCAL-ID
    • GLOBUS ENDPOINT MY-SHARED-ENDPOINT-LIST
    • GLOBUS ENDPOINT PERMISSION CREATE
    • GLOBUS ENDPOINT PERMISSION DELETE
    • GLOBUS ENDPOINT PERMISSION LIST
    • GLOBUS ENDPOINT PERMISSION SHOW
    • GLOBUS ENDPOINT PERMISSION UPDATE
    • GLOBUS ENDPOINT ROLE CREATE
    • GLOBUS ENDPOINT ROLE DELETE
    • GLOBUS ENDPOINT ROLE LIST
    • GLOBUS ENDPOINT ROLE SHOW
    • GLOBUS ENDPOINT SEARCH
    • GLOBUS ENDPOINT SERVER ADD
    • GLOBUS ENDPOINT SERVER DELETE
    • GLOBUS ENDPOINT SERVER LIST
    • GLOBUS ENDPOINT SERVER SHOW
    • GLOBUS ENDPOINT SERVER UPDATE
    • GLOBUS ENDPOINT SET-SUBSCRIPTION-ID
    • GLOBUS ENDPOINT SHOW
    • GLOBUS ENDPOINT STORAGE-GATEWAY LIST
    • GLOBUS ENDPOINT UPDATE
    • GLOBUS ENDPOINT USER-CREDENTIAL CREATE FROM-JSON
    • GLOBUS ENDPOINT USER-CREDENTIAL CREATE POSIX
    • GLOBUS ENDPOINT USER-CREDENTIAL CREATE S3
    • GLOBUS ENDPOINT USER-CREDENTIAL DELETE
    • GLOBUS ENDPOINT USER-CREDENTIAL LIST
    • GLOBUS ENDPOINT USER-CREDENTIAL SHOW
    • GLOBUS FLOWS DELETE
    • GLOBUS FLOWS LIST
    • GLOBUS FLOWS SHOW
    • GLOBUS FLOWS START
    • GLOBUS GCP CREATE GUEST
    • GLOBUS GCP CREATE MAPPED
    • GLOBUS GET-IDENTITIES
    • GLOBUS GROUP CREATE
    • GLOBUS GROUP DELETE
    • GLOBUS GROUP INVITE ACCEPT
    • GLOBUS GROUP INVITE DECLINE
    • GLOBUS GROUP JOIN
    • GLOBUS GROUP LEAVE
    • GLOBUS GROUP LIST
    • GLOBUS GROUP MEMBER ADD
    • GLOBUS GROUP MEMBER APPROVE
    • GLOBUS GROUP MEMBER INVITE
    • GLOBUS GROUP MEMBER LIST
    • GLOBUS GROUP MEMBER REJECT
    • GLOBUS GROUP MEMBER REMOVE
    • GLOBUS GROUP SET-POLICIES
    • GLOBUS GROUP SHOW
    • GLOBUS GROUP UPDATE
    • GLOBUS LIST-COMMANDS
    • GLOBUS LOGIN
    • GLOBUS LOGOUT
    • GLOBUS LS
    • GLOBUS MKDIR
    • GLOBUS RENAME
    • GLOBUS RM
    • GLOBUS SEARCH DELETE-BY-QUERY
    • GLOBUS SEARCH INDEX CREATE
    • GLOBUS SEARCH INDEX DELETE
    • GLOBUS SEARCH INDEX LIST
    • GLOBUS SEARCH INDEX ROLE CREATE
    • GLOBUS SEARCH INDEX ROLE DELETE
    • GLOBUS SEARCH INDEX ROLE LIST
    • GLOBUS SEARCH INDEX SHOW
    • GLOBUS SEARCH INGEST
    • GLOBUS SEARCH QUERY
    • GLOBUS SEARCH SUBJECT DELETE
    • GLOBUS SEARCH SUBJECT SHOW
    • GLOBUS SEARCH TASK LIST
    • GLOBUS SEARCH TASK SHOW
    • GLOBUS SESSION CONSENT
    • GLOBUS SESSION SHOW
    • GLOBUS SESSION UPDATE
    • GLOBUS TASK CANCEL
    • GLOBUS TASK EVENT-LIST
    • GLOBUS TASK GENERATE-SUBMISSION-ID
    • GLOBUS TASK LIST
    • GLOBUS TASK PAUSE-INFO
    • GLOBUS TASK SHOW
    • GLOBUS TASK UPDATE
    • GLOBUS TASK WAIT
    • GLOBUS TIMER CREATE TRANSFER
    • GLOBUS TIMER DELETE
    • GLOBUS TIMER LIST
    • GLOBUS TIMER SHOW
    • GLOBUS TRANSFER
    • GLOBUS UPDATE
    • GLOBUS VERSION
    • GLOBUS WHOAMI
  • Examples
© 2010- The University of Chicago Legal Privacy Accessibility