1datalad download-url(1)     General Commands Manual    datalad download-url(1)
2
3
4

NAME

6       datalad download-url - download content
7

SYNOPSIS

9       datalad   download-url  [-h]  [-d  PATH]  [-O  PATH]  [-o]  [--archive]
10              [--nosave] [-m MESSAGE] [--version] url [url ...]
11
12
13

DESCRIPTION

15       It allows for a uniform download interface  to  various  supported  URL
16       schemes  (see command help for details), re-using or asking for authen‐
17       tication details maintained by datalad.
18
19   Examples
20       Download files from an http and S3 URL::
21
22        %   datalad   download-url   http://example.com/file.dat    s3://buck‐
23       et/file2.dat
24
25       Download a file to a path and provide a commit message::
26
27        %  datalad  download-url -m 'added a file' -O myfile.dat    s3://buck‐
28       et/file2.dat
29
30       Append a trailing slash to the target path to download into a specified
31       directory::
32
33        % datalad download-url --path=data/ http://example.com/file.dat
34
35       Leave off the trailing slash to download into a regular file::
36
37        % datalad download-url --path=data http://example.com/file.dat
38
39

OPTIONS

41       url    URL(s)  to  be  downloaded.  Supported protocols: 'ftp', 'http',
42              'https', 's3', 'shub'. Constraints: value must be a string
43
44
45       -h, --help, --help-np
46              show this help message. --help-np forcefully disables the use of
47              a pager for displaying the help message
48
49       -d PATH, --dataset PATH
50              specify  the dataset to add files to. If no dataset is given, an
51              attempt is made to identify the dataset  based  on  the  current
52              working  directory.  Use --nosave to prevent adding files to the
53              dataset. Constraints: Value must be a Dataset or a valid identi‐
54              fier of a Dataset (e.g. a path) or value must be NONE
55
56       -O PATH, --path PATH
57              target for download. If the path has a trailing separator, it is
58              treated as a directory, and each specified URL is downloaded un‐
59              der  that directory to a base name taken from the URL. Without a
60              trailing separator, the value specifies the name  of  the  down‐
61              loaded  file  (file name extensions inferred from the URL may be
62              added to it, if they are not yet present) and only a single  URL
63              should be given. In both cases, leading directories will be cre‐
64              ated if needed. This argument defaults to the current directory.
65              Constraints: value must be a string or value must be NONE
66
67       -o, --overwrite
68              flag to overwrite it if target file exists.
69
70       --archive
71              pass   the   downloaded  files  to  datalad  add-archive-content
72              --delete.
73
74       --nosave
75              by default all modifications to a dataset are immediately saved.
76              Giving this option will disable this behavior.
77
78       -m MESSAGE, --message MESSAGE
79              a  description  of  the  state or the changes made to a dataset.
80              Constraints: value must be a string or value must be NONE
81
82       --version
83              show the module and its version which provides the command
84

AUTHORS

86        datalad is developed by The DataLad Team and Contributors <team@datal‐
87       ad.org>.
88
89
90
91datalad download-url 0.19.3       2023-08-11           datalad download-url(1)
Impressum