NAME¶

datalad ls - list summary information about URLs and dataset(s)

SYNOPSIS¶

datalad ls [-h] [-r] [-F] [-a] [-L] [--config-file CONFIG_FILE] [--list-content {None,first10,md5,full}] [--json {file,display,delete}] [PATH/URL ...]

DESCRIPTION¶

ATM only s3:// URLs and datasets are supported

Examples:

$ datalad ls s3://openfmri/tarballs/ds202 # to list S3 bucket $ datalad ls # to list current dataset

OPTIONS¶

PATH/URL

URL or path to list, e.g. s3://... Constraints: value must be a string

-h, --help, --help-np

show this help message. --help-np forcefully disables the use of a pager for displaying the help message

-r, --recursive

recurse into subdirectories.

-F, --fast

only perform fast operations. Would be overridden by --all.

-a, --all

list all (versions of) entries, not e.g. only latest entries in case of S3.

-L, --long

list more information on entries (e.g. acl, urls in s3, annex sizes etc).

--config-file CONFIG_FILE

path to config file which could help the 'ls'. E.g. for s3:// URLs could be some ~/.s3cfg file which would provide credentials. Constraints: value must be a string

--list-content {None, first10,md5,full}

list also the content or only first 10 bytes (first10), or md5 checksum of an entry. Might require expensive transfer and dump binary output to your screen. Do not enable unless you know what you are after. [Default: False]

--json {file, display, delete}

metadata json of dataset for creating web user interface. display: prints jsons to stdout or file: writes each subdir metadata to json file in subdir of dataset or delete: deletes all metadata json files in dataset.

AUTHORS¶

datalad is developed by The DataLad Team and Contributors <team@datalad.org>.