Install the GRA CLI

1. Requirements

The Globus Registered API, or "GRA", is a console application written in Python.

Regardless of which installation tool you choose to use, your system must have Python 3.10 or higher already installed.

You can check whether Python is already installed by running:

python --version

If you see a Python version printed, like Python 3.14.3 and the displayed version is "3.10.0" or higher, then congratulations! Python is already installed.

However, if Python is not installed, you will need to download Python and install it.

2. Install

Use your favorite python package management tool to install globus-registered-api from PyPI.

Specific instructions for 3 common tools are provided in the following table.

Install

pipx install globus-registered-api

Upgrade

pipx upgrade globus-registered-api

Install

python -m pip install --user globus-registered-api

Upgrade

python -m pip install --upgrade --user globus-registered-api

Install

uv tool install globus-registered-api

Upgrade

uv tool install --upgrade globus-registered-api

3. Log in

Once GRA is installed, you will need to log in.

Login happens automatically when a network callout is required. Very simply:

gra session whoami
Note

If instead of a login URL, you see your username, then you are already logged in. You can skip the rest of this section (or run globus session logout if you were particularly excited about logging in).

Open the printed login URL in your browser and follow the login prompt.

Once complete, copy and paste the resulting authorization code back into the awaiting terminal prompt.

Enter the resulting Authorization Code here: AAbbCCddEEffGGhhIIjjKKllMMnnOO

Press [ENTER] and you should see your account identifier print on-screen.

4. Next Steps

Now that you have installed the CLI and logged in, we can use it to register your first API with the Globus Flows service.

Next Tutorial: Register your first API