Getting Started with Globus Command Line Interface

Note: This guide assumes that you already have Globus Personal Connect installed and running. If it is not installed, please download and install Globus Personal Connect and run it first.

1. Install Globus CLI

Ensure you have Python installed on your system.

Install Globus CLI using pip:

pip install globus-cli

2. Authenticate Your Account

Authenticate your Globus account through the CLI. This step requires you to log in through a web browser.

globus login

Enter the authorization code in the terminal window to continue.

3. Identify Endpoints

You can find your Globus Personal Connect Endpoint ID using:

globus endpoint local-id

Next, you need the Endpoint ID of the Globus Endpoint to transfer files with.

You can search for endpoints using:

globus endpoint search "Endpoint Name"

For example, the following shows the search command and results for the endpoint "CU Boulder Research Computing".

4. Activate Endpoints

Endpoints must be activated before use. This is usually done automatically for personal endpoints.

To activate an endpoint manually (do not include the square brackets):

globus endpoint activate [Endpoint ID]

5. List Files on an Endpoint

To see the files on an endpoint:

globus ls [Endpoint ID]:/[Path]

6. Transfer Files

To transfer a file from your personal endpoint to another endpoint:

globus transfer [Your Endpoint ID]:/[File Path] [Remote Endpoint ID]:/[Destination Path]

7. Check Transfer Status

To check the status of your transfer:

globus task list

8. Cancel a Transfer

If you need to cancel a transfer:

globus task cancel [Task ID]

Automating Transfers at Regular Intervals

Globus Transfers may be automated by writing bash or python scripts using the commands discussed above to suit your needs. However, automation is not covered in this article.