Command Line Interface (CLI) Reference
Last Updated: February 02, 2021
- globus list-commands
-
List all CLI Commands
- globus version
-
Show the version and exit
- globus update
-
Update the Globus CLI to its latest version
- globus login
-
Log into Globus to get credentials for the Globus CLI
- globus logout
-
Logout of the Globus CLI
- globus whoami
-
Show the currently logged-in identity
- globus get-identities
-
Lookup Globus Auth Identities
- globus ls
-
List endpoint directory contents
- globus mkdir
-
Create a directory on an endpoint
- globus rename
-
Rename a file or directory on an endpoint
- globus delete
-
Submit a delete task (asynchronous)
- globus rm
-
Delete a single path; wait for it to complete
- globus transfer
-
Submit a transfer task (asynchronous)
globus endpoint commands
- globus endpoint search
-
Find and discover endpoints
- globus endpoint show
-
Display a detailed endpoint definition
- globus endpoint create
-
Create a new endpoint
- globus endpoint update
-
Update attributes of an endpoint
- globus endpoint delete
-
Delete an endpoint
- globus endpoint set-subscription-id
-
Set an endpoint’s subscription
- globus endpoint activate
-
Activate an endpoint
- globus endpoint is-activated
-
Check if an endpoint is activated
- globus endpoint deactivate
-
Deactivate an endpoint
- globus endpoint my-shared-endpoint-list
-
List all shared endpoints on an endpoint by the current user
- globus endpoint local-id
-
Display UUID of locally installed endpoint
globus endpoint permission commands
- globus endpoint permission list
-
List access control rules
- globus endpoint permission create
-
Create an access control rule
- globus endpoint permission show
-
Display an access control rule
- globus endpoint permission update
-
Update an access control rule
- globus endpoint permission delete
-
Delete an access control rule
globus endpoint role commands
- globus endpoint role list
-
List roles on an endpoint
- globus endpoint role show
-
Show full info for a role on an endpoint
- globus endpoint role create
-
Add a role to an endpoint
- globus endpoint role delete
-
Remove a role from an endpoint
globus endpoint server commands
- globus endpoint server list
-
List all servers for an endpoint
- globus endpoint server show
-
Show an endpoint server
- globus endpoint server add
-
Add a server to an endpoint
- globus endpoint server update
-
Update an endpoint server
- globus endpoint server delete
-
Delete a server belonging to an endpoint
globus bookmark commands
- globus bookmark list
-
List your bookmarks
- globus bookmark create
-
Create a bookmark for the current user
- globus bookmark delete
-
Delete a bookmark
- globus bookmark rename
-
Change a bookmark’s name
- globus bookmark show
-
Resolve a bookmark name or ID to an endpoint:path
globus task commands
- globus task list
-
List your tasks
- globus task show
-
Show detailed information about a task
- globus task update
-
Update a task
- globus task cancel
-
Cancel a task
- globus task event-list
-
List events for a given task
- globus task pause-info
-
Show why an in-progress task is currently paused
- globus task wait
-
Wait for a task to complete
- globus task generate-submission-id
-
Get a task submission ID
globus session commands
- globus session update
-
Update your CLI auth session
- globus session show
-
Show your current CLI auth session
- globus session consent
-
Update your session with specific consents