CLI Menu

Command Line Interface (CLI) CLI QuickStart GuideCommand Line Interface (CLI) ExamplesUsing the CLI with High Assurance Resources


globus bookmark create - Create a new bookmark


globus bookmark create ['OPTIONS'] 'ENDPOINT_ID:PATH' 'BOOKMARK_NAME'


The globus bookmark create command creates a new bookmark. Given an endpoint plus a path, and a name for the bookmark, the service will generate the bookmark’s ID.

Bookmarks are aliases for locations on endpoints, and their names are unique per account. You may not have multiple bookmarks with the same name. You can use bookmarks in other commands by using globus bookmark show.

The new bookmark name may be up to 128 characters long. Bookmarks are only visible and usable for the user who created them. If the target endpoint is private or deleted, the bookmark is unusable.

'PATH' is assumed to be URL-encoded. 'PATH' must be a directory and end with "/".


--map-http-status 'TEXT'

Map non success HTTP response codes to exit codes other than 1. e.g. "--map-http-satus 403=0,404=0" would exit with 0 even if a 403 or 404 http error code was received. Valid exit codes are 0,1,50-99.

-F, --format '[json|text]'

Set the output format for stdout. Defaults to "text".

--jq, --jmespath 'EXPR'

Supply a JMESPath expression to apply to json output. Takes precedence over any specified '--format' and forces the format to be json processed by this expression.

A full specification of the JMESPath language for querying JSON structures may be found at

-h, --help

Show help text for this command.

-v, --verbose

Control the level of output.

Use -v or --verbose to show warnings and any additional text output.

Use -vv to add informative logging.

Use -vvv to add debug logging and full stack on any errors. (equivalent to -v --debug)


When textual output is requested, the only result shown is the ID of the created bookmark.


Create a bookmark named 'mybookmark':

$ globus bookmark create 'ddb59aef-6d04-11e5-ba46-22000b92c6ec:/~/' mybookmark

Take a specific field from the JSON output and format it into unix-friendly output by using '--jmespath' and '--format=UNIX':

$ globus bookmark create \
    'ddb59aef-6d04-11e5-ba46-22000b92c6ec:/~/' mybookmark \
     -F unix --jmespath 'id'


0 on success.

1 if a network or server error occurred, unless --map-http-status has been used to change exit behavior on http error codes.

2 if the command was used improperly.

© 2010- The University of Chicago Legal