Command Reference

The DataFed command-line-interface (CLI) provides access to basic DataFed capabilities for both interactive use and non-interactive scripting from a command shell, and is the primary means of utilizing DataFed from within data, compute, and analytics environments. The DataFed CLI is provided via a Python 3 package and can be used on any operating system where Python 3 is available.

This document provides detailed information about the commands and sub-commands of the DataFed CLI. For general CLI usage information, see the CLI User Guide page. Also, before the DataFed CLI can be used it must be installed and properly configured - the CLI Installation and Configuration page provides details.

Datafed Commands

‘datafed’ is the command-line interface (CLI) for the DataFed federated data management

service and may be used to access many of the features available via the DataFed web portal. This CLI may be used interactively (human-friendly output) or for scripting (JSON output) by specifying the -s option.

When the datafed CLI is run without any command arguments, a interactive shell session is started. While in the shell, commands should be entered without specifying the ‘datafed’ prefix.

Usage:

datafed [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-m, –manual-auth	Force manual authentication
-s, –script	Start in non-interactive scripting mode. Output is in JSON, all intermediate I/O is disabled, and certain client-side commands are unavailable.
–version	Print version number and exit.
–server-cfg-dir TEXT	Server configuration directory
–server-cfg-file TEXT	Server configuration file
–server-pub-key-file TEXT	Server public key file
-H, –server-host TEXT	Sever host name or IP address
-P, –server-port INTEGER	Server port number
–client-cfg-dir TEXT	Client configuration directory
–client-cfg-file TEXT	Client configuration file
–client-pub-key-file TEXT	Client public key file
–client-priv-key-file TEXT	Client private key file
-e, –default-ep TEXT	Default Globus endpoint
-v, –verbosity INTEGER	Verbosity level (0=quiet,1=normal,2=verbose) for text-format output only.
-h, –help	Show this message and exit.

Sub-Commands:

coll	Collection commands.
data	Data commands.
ep	Endpoint commands.
exit	Exit an interactive session.
help	Show DataFed CLI help.
ls	List contents of a collection, or shared items.
project	Project commands.
query	Data query commands.
setup	Setup local credentials.
shares	List users and/or projects sharing data with current user.
task	Task management commands.
user	User commands.
verbosity	Set/display verbosity level.
wc	Set/print current working collection or path.
wp	Get current working path.

Coll Commands

Collection commands.

Usage:

datafed coll [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

add	Add data records and/or collections to a collection.
create	Create a new collection.
delete	Delete one or more existing collections.
remove	Remove data records and/or collections from a collection.
update	Update an existing collection.
view	View collection information.

Coll Add Command

Add data records and/or collections to a collection. COLL_ID is the destination collection and ITEM_IDs specify one or more data records and/or collections to add to the destination collection. COLL_ID and ITEM_IDs may be IDs, aliases, or index values from a listing. COLL_ID may also be a relative collection path (‘.’, ‘..’, or ‘/’).

Usage:

datafed coll add [OPTIONS] COLL_ID ITEM_ID

Options:

Option	Description
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Coll Create Command

Create a new collection. The collection ‘title’ is required, but all other attributes are optional. On success, the ID of the created collection is returned. Note that if a parent collection is specified, and that collection belongs to a project or other collaborator, the creating user must have permission to write to that collection.

Usage:

datafed coll create [OPTIONS] TITLE

Options:

Option	Description
-a, –alias TEXT	Alias
-p, –parent TEXT	Parent collection ID/alias (default is current working collection)
-d, –description TEXT	Description text
-T, –tags TEXT	Tags (comma separated list).
–topic TEXT	Publish the collection to the provided topic.
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-v, –verbosity [0|1|2]	Verbosity level of output
-h, –help	Show this message and exit.

Coll Delete Command

Delete one or more existing collections. Multiple ID arguments can be provided and may be collection IDs, aliases, or index values from a listing. By default, a confirmation prompt is used, but this can be bypassed with the ‘–force’ option.

When a collection is deleted, all contained collections are also deleted; however, contained data records are only deleted if they are not linked to another collection not involved in the deletion.

Usage:

datafed coll delete [OPTIONS] ID

Options:

Option	Description
-f, –force	Delete without confirmation.
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Coll Remove Command

Remove data records and/or collections from a collection. COLL_ID is the containing collection and ITEM_IDs specify one or more data records and/or collections to remove from the containing collection. COLL_ID and ITEM_IDs may be IDs, aliases, or index values from a listing. COLL_ID may also be a relative collection path (‘.’, ‘..’, or ‘/’).

Usage:

datafed coll remove [OPTIONS] COLL_ID ITEM_ID

Options:

Option	Description
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Coll Update Command

Update an existing collection. The collection ID is required and can be an ID, alias, or listing index; all other collection attributes are optional.

Usage:

datafed coll update [OPTIONS] ID

Options:

Option	Description
-t, –title TEXT	Title
-a, –alias TEXT	Alias
-d, –description TEXT	Description text
-T, –tags TEXT	Tags (comma separated list).
–topic TEXT	Publish the collection under the provided topic.
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-v, –verbosity [0|1|2]	Verbosity level of output
-h, –help	Show this message and exit.

Coll View Command

View collection information. Displays collection title, description, and other administrative fields. ID may be a collection identifier, alias, or index value from a listing. Use ‘coll list’ command to see items contained in a collection.

Usage:

datafed coll view [OPTIONS] ID

Options:

Option	Description
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-v, –verbosity [0|1|2]	Verbosity level of output
-h, –help	Show this message and exit.

Data Commands

Data commands.

Usage:

datafed data [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

batch	Data batch commands.
create	Create a new data record.
delete	Delete one or more existing data records.
get	Get (download) raw data of data records and/or collections.
put	Put (upload) raw data located at PATH to DataFed record ID.
update	Update an existing data record.
view	View data record information.

Data Batch Commands

Data batch commands.

Usage:

datafed data batch [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

create	Batch create data records from JSON file(s).
update	Batch update data records from JSON file(s).

Data Batch Create Command

Batch create data records from JSON file(s). Multiple FILE arguments may be specified and are absolute or relative paths to JSON inputs file on a local filesystem. JSON input files may contain individual JSON objects, or arrays of JSON objects. Each JSON object represents a new data record and the JSON must comply with the DataFed record input schema (see online documentation).

Usage:

datafed data batch create [OPTIONS] FILE

Options:

Option	Description
-c, –collection TEXT	Optional target collection (default is root).
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Data Batch Update Command

Batch update data records from JSON file(s). Multiple FILE arguments may be specified and are absolute or relative paths to JSON inputs file on a local filesystem. JSON input files may contain individual JSON objects, or arrays of JSON objects. Each JSON object represents a new data record and the JSON must comply with the DataFed record input schema (see online documentation).

Usage:

datafed data batch update [OPTIONS] FILE...

Options:

Option	Description
-h, –help	Show this message and exit.

Data Create Command

Create a new data record. The data record ‘title’ is required, but all other attributes are optional. On success, the ID of the created data record is returned. Note that if a parent collection is specified, and that collection belongs to a project or other collaborator, the creating user must have permission to write to that collection. The raw-data-file option is only supported in interactive mode and is provided as a convenience to avoid a separate dataPut() call.

Usage:

datafed data create [OPTIONS] TITLE

Options:

Option	Description
-a, –alias TEXT	Record alias.
-d, –description TEXT	Description text.
-T, –tags TEXT	Tags (comma separated list).
-r, –raw-data-file TEXT	Globus path to raw data file (local or remote) to upload to new record. Default endpoint is used if none provided.
-x, –extension TEXT	Override raw data file extension if provided (default is auto detect).
-E, –external	Raw data file is external to DataFed (unmanaged)
-m, –metadata TEXT	Inline metadata in JSON format. JSON must define an object type. Cannot be specified with –metadata-file option.
-f, –metadata-file TEXT	Path to local metadata file containing JSON. JSON must define an object type. Cannot be specified with –metadata option.
-s, –schema TEXT	Set metadata schema id:version
-e, –schema-enforce	Fail on metadata validation errors
-p, –parent TEXT	Parent collection ID, alias, or listing index. Default is the current working collection.
-R, –repository TEXT	Repository ID (managed data only). Uses default allocation if not specified.
-D, –deps <CHOICE TEXT>…	Dependencies (provenance). Use one ‘–deps’ option per dependency and specify with a string consisting of the type of relationship (‘der’, ‘comp’, ‘ver’) follwed by ID/alias of the referenced record. Relationship types are: ‘der’ for ‘derived from’, ‘comp’ for ‘a component of’, and ‘ver’ for ‘a new version of’.
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-v, –verbosity [0|1|2]	Verbosity level of output
-h, –help	Show this message and exit.

Data Delete Command

Delete one or more existing data records. Multiple ID arguments can be provided and may data record IDs, aliases, or index values from a listing. By default, a confirmation prompt is used, but this can be bypassed with the ‘–force’ option.

Usage:

datafed data delete [OPTIONS] ID

Options:

Option	Description
-f, –force	Delete record(s) without confirmation.
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Data Get Command

Get (download) raw data of data records and/or collections. Multiple ID arguments can be specified and may be data record and/or collection IDs, aliases, or index values from s listing. The PATH argument is the destination for the download and can be either a full Globus path (with endpoint), or a local file system path (absolute or relative).

If no endpoint is specified in the PATH argument, the current endpoint will be used. If the destination PATH doesn’t exist, it will be created given sufficient filesystem permissions. Note that the path does not have to be local to where the CLI is running - data can be transferred to/from remote systems; however, full Globus paths must used in this case.

Usage:

datafed data get [OPTIONS] ID PATH

Options:

Option	Description
-w, –wait	Block until Globus transfer is complete.
-e, –encrypt [0|1|2]	Encryption mode: 0 = none, 1 = if available (default), 2 = force.
-o, –orig_fname	Download to original filename(s).
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Data Put Command

Put (upload) raw data located at PATH to DataFed record ID. The ID argument may be data record ID, alias, or index value from a listing. The PATH argument specifies the source file for the upload and can be either a full Globus path (with endpoint), or a local file system path (absolute or relative). If no endpoint is specified in the PATH argument, the current endpoint will be used.

Usage:

datafed data put [OPTIONS] ID PATH

Options:

Option	Description
-w, –wait	Block reply or further commands until transfer is complete
-x, –extension TEXT	Override extension for raw data file (default = auto detect).
-e, –encrypt [0|1|2]	Encryption mode: 0 = none, 1 = if available (default), 2 = force.
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Data Update Command

Update an existing data record. The data record ID is required and can be an ID, alias, or listing index; all other record attributes are optional. The raw-data-file option is only supported in interactive mode and is provided as a convenience to avoid a separate dataPut() call.

Usage:

datafed data update [OPTIONS] ID

Options:

Option	Description
-t, –title TEXT	Title
-a, –alias TEXT	Alias
-d, –description TEXT	Description text
-T, –tags TEXT	Tags (comma separated list)
-r, –raw-data-file TEXT	Globus path to raw data file (local or remote) to upload with record. Default endpoint used if none provided.
-x, –extension TEXT	Override extension for raw data file (default = auto detect).
-m, –metadata TEXT	Inline metadata in JSON format.
-f, –metadata-file TEXT	Path to local metadata file containing JSON.
-S, –metadata-set	Set (replace) existing metadata with provided instead of merging.
-s, –schema TEXT	Set metadata schema id:version
-e, –schema-enforce	Fail on metadata validation errors
-A, –deps-add <CHOICE TEXT>…	Specify dependencies to add by listing first the type of relationship (‘der’, ‘comp’, or ‘ver’) follwed by ID/alias of the target record. Can be specified multiple times.
-R, –deps-rem <CHOICE TEXT>…	Specify dependencies to remove by listing first the type of relationship (‘der’, ‘comp’, or ‘ver’) followed by ID/alias of the target record. Can be specified multiple times.
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-v, –verbosity [0|1|2]	Verbosity level of output
-h, –help	Show this message and exit.

Data View Command

View data record information. Displays record title, description, tags, and other informational and administrative fields. ID may be a data record identifier, alias, or index value from a listing. By default, description text is truncated and metadata is not shown unless the verbosity is as level 2.

Usage:

datafed data view [OPTIONS] ID

Options:

Option	Description
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-v, –verbosity [0|1|2]	Verbosity level of output
-h, –help	Show this message and exit.

Ep Commands

Endpoint commands.

Usage:

datafed ep [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

default	Default endpoint commands.
get	Get Globus endpoint for the current session.
list	List recently used endpoints.
set	Set endpoint for the current session.

Ep Default Commands

Default endpoint commands.

Usage:

datafed ep default [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

get	Show the default Globus endpoint.
set	Set the default Globus endpoint.

Ep Default Get Command

Show the default Globus endpoint.

Usage:

datafed ep default get [OPTIONS]

Options:

Option	Description
-h, –help	Show this message and exit.

Ep Default Set Command

Set the default Globus endpoint. The default endpoint will be set from the ‘endpoint’ argument, or if the ‘–current’ options is specified, from the currently active endpoint.

Usage:

datafed ep default set [OPTIONS] [ENDPOINT]

Options:

Option	Description
-c, –current	Set default endpoint to current endpoint.
-h, –help	Show this message and exit.

Ep Get Command

Get Globus endpoint for the current session. At the start of a session, the current endpoint will be set to the default endpoint, if configured.

Usage:

datafed ep get [OPTIONS]

Options:

Option	Description
-h, –help	Show this message and exit.

Ep List Command

List recently used endpoints.

Usage:

datafed ep list [OPTIONS]

Options:

Option	Description
-h, –help	Show this message and exit.

Ep Set Command

Set endpoint for the current session. If no endpoint is given, the default endpoint will be set as the current endpoint, if configured.

Usage:

datafed ep set [OPTIONS] [ENDPOINT]

Options:

Option	Description
-h, –help	Show this message and exit.

Exit Command

Exit an interactive session. Ctrl-C may also be used to exit the shell.

Usage:

datafed exit [OPTIONS]

Options:

Option	Description
-h, –help	Show this message and exit.

Help Command

Show DataFed CLI help. Include a command name as the argument to see command-specific help.

Usage:

datafed help [OPTIONS] [COMMAND]...

Options:

Option	Description
-h, –help	Show this message and exit.

Ls Command

List contents of a collection, or shared items. ID may be a collection ID or alias, a path (‘..’,’/’,’~’), a user or project ID, an index value from a listing, or omitted for the current working collection. If the ID is a user or project, the ls command will list shared items associated with the given user or project.

Note: the ‘/’ path lists the root collection of the current context (user or project); whereas the ‘~’ path always lists the root collection of the authenticated user, regardless of context.

Usage:

datafed ls [OPTIONS] ID

Options:

Option	Description
-O, –offset INTEGER	Start list at offset
-C, –count INTEGER	Limit list to count results
-X, –context TEXT	User or project ID for command alias context. See ‘alias’ command help for more information.
-h, –help	Show this message and exit.

Project Commands

Project commands.

Usage:

datafed project [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

list	List projects associated with current user.
view	View project information.

Project List Command

List projects associated with current user. List projects that are owned or managed by the current user, as well as projects were the current user is a member.

Usage:

datafed project list [OPTIONS]

Options:

Option	Description
-o, –owned	Include owned projects
-a, –admin	Include administered projects
-m, –member	Include membership projects
-O, –offset INTEGER	Start list at offset
-C, –count INTEGER	Limit list to count results
-h, –help	Show this message and exit.

Project View Command

View project information. Current user must have a role (owner, manager, or member) within the project specified by the ID argument.

Usage:

datafed project view [OPTIONS] ID

Options:

Option	Description
-v, –verbosity [0|1|2]	Verbosity level of output
-h, –help	Show this message and exit.

Query Commands

Data query commands.

Usage:

datafed query [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

create	Create a saved query.
delete	Delete a saved query by ID.
exec	Execute a saved query by ID.
list	List saved queries.
run	Run a direct query on data or collections.
update	Update a saved query.
view	View a saved query by ID.

Query Create Command

Create a saved query.

Usage:

datafed query create [OPTIONS] TITLE

Options:

Option	Description
-C, –coll-mode	Search for collections intead of data
-c, –coll TEXT	Collection to search (multiple allowed)
–id TEXT	ID/alias expression
–text TEXT	Text expression
-t, –tag TEXT	Tag (multiple allowed)
–schema TEXT	Metadata schema ID
–meta TEXT	Metadata expression
–meta-err	Metadata has validation errors
–owner TEXT	Owning user ID (only for public queries)
–creator TEXT	Creating user ID
–from TEXT	Find from specified date/time (M/D/YYYY[,HH:MM])
–to TEXT	Find up to specified date/time (M/D/YYYY[,HH:MM])
-p, –public	Search public data/collections in catalog
–category TEXT	Category (public searches only)
–sort TEXT	Sort option (id,title,owner,text,ct,ut)
–sort-rev	Sort in reverse order (not available for text)
-h, –help	Show this message and exit.

Query Delete Command

Delete a saved query by ID.

Usage:

datafed query delete [OPTIONS] ID

Options:

Option	Description
-h, –help	Show this message and exit.

Query Exec Command

Execute a saved query by ID.

Usage:

datafed query exec [OPTIONS] ID

Options:

Option	Description
-O, –offset INTEGER	Start results list at offset
-C, –count INTEGER	Limit to count results
-h, –help	Show this message and exit.

Query List Command

List saved queries.

Usage:

datafed query list [OPTIONS]

Options:

Option	Description
-O, –offset INTEGER	Start list at offset
-C, –count INTEGER	Limit list to count results
-h, –help	Show this message and exit.

Query Run Command

Run a direct query on data or collections. The default scope is the current authenticated user. If collections are specified, they must be in the same overall search scope. At least one search term must be specified.

The sort option ‘text’ is a text-matching relevance ranking and only works if a text term is specified in the query. The –sort-rev option does not work with text relevance matching. The sort options ‘ct’ and ‘ut’ are creation and update times, respectively.

Usage:

datafed query run [OPTIONS]

Options:

Option	Description
-C, –coll-mode	Search for collections intead of data
-c, –coll TEXT	Collection to search (multiple allowed)
–id TEXT	ID/alias expression
–text TEXT	Text expression
-t, –tag TEXT	Tag (multiple allowed)
–schema TEXT	Metadata schema ID
–meta TEXT	Metadata expression
–meta-err	Metadata has validation errors
–owner TEXT	Owning user ID (only for public queries)
–creator TEXT	Creating user ID
–from TEXT	Find from specified date/time (M/D/YYYY[,HH:MM])
–to TEXT	Find up to specified date/time (M/D/YYYY[,HH:MM])
-p, –public	Search public data/collections in catalog
–category TEXT	Category (public searches only)
–sort TEXT	Sort option (id,title,owner,text,ct,ut)
–sort-rev	Sort in reverse order (not available for text)
–offset INTEGER	Start result list at offset
–count INTEGER	Limit to count results (default = 20)
-h, –help	Show this message and exit.

Query Update Command

Update a saved query. The title and search terms of a query may be updated; however, search scope cannot currently be changed. To remove a term, specify an empty string (“”) for the associated option.

Usage:

datafed query update [OPTIONS] ID

Options:

Option	Description
–title TEXT	New query title
-C, –coll-mode	Search for collections intead of data
-c, –coll TEXT	Collection to search (multiple allowed)
–id TEXT	ID/alias expression
–text TEXT	Text expression
-t, –tag TEXT	Tag (multiple allowed)
–schema TEXT	Metadata schema ID
–meta TEXT	Metadata expression
–meta-err	Metadata has validation errors
–owner TEXT	Owning user ID (only for public queries)
–creator TEXT	Creating user ID
–from TEXT	Find from specified date/time (M/D/YYYY[,HH:MM])
–to TEXT	Find up to specified date/time (M/D/YYYY[,HH:MM])
-p, –public	Search public data/collections in catalog
–category TEXT	Category (public searches only)
–sort TEXT	Sort option (id,title,owner,text,ct,ut)
–sort-rev	Sort in reverse order (not available for text)
-h, –help	Show this message and exit.

Query View Command

View a saved query by ID.

Usage:

datafed query view [OPTIONS] ID

Options:

Option	Description
-h, –help	Show this message and exit.

Setup Command

Setup local credentials. This command installs DataFed credentials for the current user in the configured client configuration directory. Subsequent use of the DataFed CLI will read these credentials instead of requiring manual authentication.

Usage:

datafed setup [OPTIONS]

Options:

Option	Description
-h, –help	Show this message and exit.

Shares Command

List users and/or projects sharing data with current user.

Usage:

datafed shares [OPTIONS]

Options:

Option	Description
-u, –users	Show users only
-p, –projects	Show projects only
-h, –help	Show this message and exit.

Task Commands

Task management commands.

Usage:

datafed task [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

list	List recent tasks.
view	Show task information.

Task List Command

List recent tasks. If no time or status filter options are provided, all tasks initiated by the current user are listed, most recent first. Note that the DataFed server periodically purges tasks history such that only up to 30 days of history are retained.

Usage:

datafed task list [OPTIONS]

Options:

Option	Description
-s, –since TEXT	List from specified time (seconds default, suffix h = hours, d = days, w = weeks)
-f, –from TEXT	List from specified date/time (M/D/YYYY[,HH:MM])
-t, –to TEXT	List up to specified date/time (M/D/YYYY[,HH:MM])
-S, –status [0|1|2|3|4|queued|ready|running|succeeded|failed]	List tasks matching specified status
-O, –offset INTEGER	Start list at offset
-C, –count INTEGER	Limit list to count results
-h, –help	Show this message and exit.

Task View Command

Show task information. Use the ID argument to view a specific task record, or omit to view the latest task initiated by the current user.

Usage:

datafed task view [OPTIONS] ID

Options:

Option	Description
-h, –help	Show this message and exit.

User Commands

User commands.

Usage:

datafed user [OPTIONS] COMMAND [ARGS]...

Options:

Option	Description
-h, –help	Show this message and exit.

Sub-Commands:

all	List all users.
collab	List all users that are collaborators.
view	View user information.
who	Show current authenticated user ID.

User All Command

List all users.

Usage:

datafed user all [OPTIONS]

Options:

Option	Description
-O, –offset INTEGER	Start list at offset
-C, –count INTEGER	Limit list to count results
-h, –help	Show this message and exit.

User Collab Command

List all users that are collaborators. Collaborators are defined as users that have projects in common with the current user, or that have data- sharing relationships with the current user.

Usage:

datafed user collab [OPTIONS]

Options:

Option	Description
-O, –offset INTEGER	Start list at offset
-C, –count INTEGER	Limit list to count results
-h, –help	Show this message and exit.

User View Command

View user information.

Usage:

datafed user view [OPTIONS] UID

Options:

Option	Description
-h, –help	Show this message and exit.

User Who Command

Show current authenticated user ID.

Usage:

datafed user who [OPTIONS]

Options:

Option	Description
-h, –help	Show this message and exit.

Verbosity Command

Set/display verbosity level. The verbosity level argument can be 0 (lowest), 1 (normal), or 2 (highest). If the the level is omitted, the current verbosity level is returned.

Usage:

datafed verbosity [OPTIONS] [LEVEL]

Options:

Option	Description
-h, –help	Show this message and exit.

Wc Command

Set/print current working collection or path. ‘ID’ can be a collection ID, alias, user or project ID, listing index, previous collection (‘-‘), or path (‘..’,’/’,’~’). ‘cd’ is an alias for the ‘wc’ command.

The ‘wc’ command can be used to switch to a different user or project context by either specifying a user/project ID/alias as the argument, or by specifying a collection ID/alias that is owned by another user or project. In either case, if permission is granted, the CLI context will be changed to the associated user/project and all subsequent commands will act within that context. To return to the authenticated users context, use the ‘wc ~’ command. The ‘~’ path indicates the authenticated user’s root collection; whereas the ‘/’ path is the root colelction of the current context.

Usage:

datafed wc [OPTIONS] ID

Options:

Option	Description
-h, –help	Show this message and exit.

Wp Command

Get current working path. Displays the full path of the current working

collection starting from the root collection of the associated user or project.

Usage:

datafed wp [OPTIONS]

Options:

Option	Description
-h, –help	Show this message and exit.