Command Line Interface (CLI) Reference
Last Updated: April 21, 2023
- globus cli-profile-list
-
List all CLI profiles which have been used
- globus delete
-
Submit a delete task (asynchronous)
- globus get-identities
-
Lookup Globus Auth Identities
- globus list-commands
-
List all CLI Commands
- globus login
-
Log into Globus to get credentials for the Globus CLI
- globus logout
-
Logout of the Globus CLI
- 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 rm
-
Delete a single path; wait for it to complete
- globus transfer
-
Submit a transfer task (asynchronous)
- globus update
-
Update the Globus CLI to its latest version
- globus version
-
Show the version and exit
- globus whoami
-
Show the currently logged-in identity
globus api commands
- globus api auth
-
Make API calls to Globus Auth
- globus api flows
-
Make API calls to Globus Flows
- globus api groups
-
Make API calls to Globus Groups
- globus api search
-
Make API calls to Globus Search
- globus api timer
-
Make API calls to Globus Timer
- globus api transfer
-
Make API calls to Globus Transfer
globus bookmark commands
- globus bookmark create
-
Create a bookmark for the current user
- globus bookmark delete
-
Delete a bookmark
- globus bookmark list
-
List your bookmarks
- globus bookmark rename
-
Change a bookmark’s name
- globus bookmark show
-
Resolve a bookmark name or ID to an endpoint:path
globus collection commands
- globus collection delete
-
Delete an existing Collection
- globus collection list
-
List all Collections on an Endpoint
- globus collection show
-
Show a Collection definition
- globus collection update
-
Update a Collection definition
globus endpoint commands
- globus endpoint activate
-
Activate an endpoint
- globus endpoint deactivate
-
Deactivate an endpoint
- globus endpoint delete
-
Delete an endpoint
- globus endpoint is-activated
-
Check if an endpoint is activated
- globus endpoint local-id
-
Display UUID of locally installed endpoint
- globus endpoint my-shared-endpoint-list
-
List all shared endpoints on an endpoint by the current user
- globus endpoint search
-
Find and discover endpoints
- globus endpoint set-subscription-id
-
Set an endpoint’s subscription
- globus endpoint show
-
Display a detailed endpoint definition
- globus endpoint update
-
Update attributes of an endpoint
globus endpoint permission commands
- globus endpoint permission create
-
Create an access control rule
- globus endpoint permission delete
-
Delete an access control rule
- globus endpoint permission list
-
List access control rules
- globus endpoint permission show
-
Display an access control rule
- globus endpoint permission update
-
Update an access control rule
globus endpoint role commands
- globus endpoint role create
-
Add a role to an endpoint
- globus endpoint role delete
-
Remove a role from an endpoint
- globus endpoint role list
-
List roles on an endpoint
- globus endpoint role show
-
Show full info for a role on an endpoint
globus endpoint server commands
- globus endpoint server add
-
Add a server to an endpoint
- globus endpoint server delete
-
Delete a server belonging to an endpoint
- globus endpoint server list
-
List all servers for an endpoint
- globus endpoint server show
-
Show an endpoint server
- globus endpoint server update
-
Update an endpoint server
globus endpoint storage-gateway commands
- globus endpoint storage-gateway list
-
List the Storage Gateways on an Endpoint
globus endpoint user-credential commands
- globus endpoint user-credential delete
-
Delete a specific User Credential on an Endpoint
- globus endpoint user-credential list
-
List all User Credentials on an Endpoint
- globus endpoint user-credential show
-
Show a specific User Credential on an Endpoint
globus endpoint user-credential create commands
- globus endpoint user-credential create from-json
-
Create a User Credential from a JSON document
- globus endpoint user-credential create posix
-
Create a User Credential for a POSIX storage gateway
- globus endpoint user-credential create s3
-
Create a User Credential for an S3 Storage Gateway
globus flows commands
- globus flows delete
-
Delete a flow
- globus flows list
-
List flows
- globus flows show
-
Show a flow
- globus flows start
-
Start a flow
globus gcp create commands
- globus gcp create guest
-
Create a new Guest Collection on GCP
- globus gcp create mapped
-
Create a new GCP Mapped Collection
globus group commands
- globus group create
-
Create a new group
- globus group delete
-
Delete a group
- globus group join
-
Join a group
- globus group leave
-
Leave a group
- globus group list
-
List groups you belong to
- globus group set-policies
-
Update an existing group’s policies
- globus group show
-
Show a group definition
- globus group update
-
Update an existing group.
globus group invite commands
- globus group invite accept
-
Accept an invitation
- globus group invite decline
-
Decline an invitation
globus group member commands
- globus group member add
-
Add a member to a group
- globus group member approve
-
Approve a member to join a group
- globus group member invite
-
Invite a user to a group
- globus group member list
-
List group members
- globus group member reject
-
Reject a member from a group
- globus group member remove
-
Remove a member from a group
globus search commands
- globus search delete-by-query
-
Perform a delete-by-query
- globus search ingest
-
Ingest a document into Globus Search
- globus search query
-
Perform a search
globus search index commands
- globus search index create
-
(BETA) Create a new Index
- globus search index delete
-
(BETA) Delete a Search Index
- globus search index list
-
List indices where you have some permissions
- globus search index show
-
Display information about an index
globus search index role commands
- globus search index role create
-
Create a role (requires admin or owner)
- globus search index role delete
-
Delete a role (requires admin or owner)
- globus search index role list
-
List roles on an index (requires admin)
globus search subject commands
- globus search subject delete
-
Delete a subject (requires writer, admin,…
- globus search subject show
-
Show the data for a given subject in an index
globus search task commands
- globus search task list
-
List recent Tasks for an index
- globus search task show
-
Display a Task
globus session commands
- globus session consent
-
Update your session with specific consents
- globus session show
-
Show your current CLI auth session
- globus session update
-
Update your CLI auth session
globus task commands
- globus task cancel
-
Cancel a task
- globus task event-list
-
List events for a given task
- globus task generate-submission-id
-
Get a task submission ID
- globus task list
-
List your tasks
- globus task pause-info
-
Show why an in-progress task is currently paused
- globus task show
-
Show detailed information about a task
- globus task update
-
Update a task
- globus task wait
-
Wait for a task to complete
globus timer commands
- globus timer delete
-
Delete a timer job
- globus timer list
-
List your jobs
- globus timer show
-
Display a Timer job
globus timer create commands
- globus timer create transfer
-
Create a recurring transfer job in Timer