|
35 | 35 | ## CLI Tool |
36 | 36 |
|
37 | 37 | This package provides a command line utility with a basic interface |
38 | | -to help you prepare and upload your data to, or obtain data from, the [DANDI archive](http://dandiarchive.org): |
39 | | - |
40 | | -```bash |
41 | | -$> dandi |
42 | | -Usage: dandi [OPTIONS] COMMAND [ARGS]... |
43 | | - |
44 | | - A client to support interactions with DANDI archive |
45 | | - (http://dandiarchive.org). |
46 | | - |
47 | | - To see help for a specific command, run |
48 | | - |
49 | | - dandi COMMAND --help |
50 | | - |
51 | | - e.g. dandi upload --help |
52 | | - |
53 | | -Options: |
54 | | - --version |
55 | | - -l, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL] |
56 | | - Log level (case insensitive). May be |
57 | | - specified as an integer. [default: INFO] |
58 | | - --pdb Fall into pdb if errors out |
59 | | - --help Show this message and exit. |
60 | | - |
61 | | -Commands: |
62 | | - delete Delete dandisets and assets from the server. |
63 | | - digest Calculate file digests |
64 | | - download Download a file or entire folder from DANDI. |
65 | | - instances List known Dandi Archive instances that the CLI can... |
66 | | - ls List .nwb files and dandisets metadata. |
67 | | - move Move or rename assets in a local Dandiset and/or on... |
68 | | - organize (Re)organize files according to the metadata. |
69 | | - service-scripts Various utility operations |
70 | | - shell-completion Emit shell script for enabling command completion. |
71 | | - upload Upload Dandiset files to DANDI Archive. |
72 | | - validate Validate files for NWB and DANDI compliance. |
73 | | - validate-bids Validate BIDS paths. |
74 | | -``` |
75 | | -
|
76 | | -Each of the commands has a set of options to alter its behavior. Run |
77 | | -`dandi COMMAND --help` to get more information: |
78 | | -
|
79 | | -``` |
80 | | -$> dandi ls --help |
81 | | -Usage: dandi ls [OPTIONS] PATH|URL |
82 | | - |
83 | | - List .nwb files and dandisets metadata. |
84 | | - |
85 | | - The arguments may be either resource identifiers or paths to local |
86 | | - files/directories. |
87 | | - |
88 | | - Accepted resource identifier patterns: |
89 | | - - DANDI:<dandiset id>[/<version>] |
90 | | - - https://dandiarchive.org/... |
91 | | - - https://identifiers.org/DANDI:<dandiset id>[/<version id>] (<version id> cannot be 'draft') |
92 | | - - https://<server>[/api]/[#/]dandiset/<dandiset id>[/<version>][/files[?location=<path>]] |
93 | | - - https://*dandiarchive-org.netflify.app/... |
94 | | - - https://<server>[/api]/dandisets/<dandiset id>[/versions[/<version>]] |
95 | | - - https://<server>[/api]/assets/<asset id>[/download] |
96 | | - - https://<server>[/api]/dandisets/<dandiset id>/versions/<version>/assets/<asset id>[/download] |
97 | | - - https://<server>[/api]/dandisets/<dandiset id>/versions/<version>/assets/?path=<path> |
98 | | - - dandi://<instance name>/<dandiset id>[@<version>][/<path>] |
99 | | - - https://<server>/... |
100 | | - |
101 | | -Options: |
102 | | - -F, --fields TEXT Comma-separated list of fields to display. |
103 | | - An empty value to trigger a list of |
104 | | - available fields to be printed out |
105 | | - -f, --format [auto|pyout|json|json_pp|json_lines|yaml] |
106 | | - Choose the format/frontend for output. If |
107 | | - 'auto', 'pyout' will be used in case of |
108 | | - multiple files, and 'yaml' for a single |
109 | | - file. |
110 | | - -r, --recursive Recurse into content of |
111 | | - dandisets/directories. Only .nwb files will |
112 | | - be considered. |
113 | | - -J, --jobs INTEGER Number of parallel download jobs. [default: |
114 | | - 6] |
115 | | - --metadata [api|all|assets] |
116 | | - --schema VERSION Convert metadata to new schema version |
117 | | - --help Show this message and exit. |
118 | | -``` |
119 | | -
|
120 | | -
|
121 | | -## Third-party Components |
122 | | -
|
123 | | -**dandi/tests/skip.py** -- from https://github.com/ReproNim/reproman, as of v0.2.1-40-gf4f026d |
124 | | -Copyright (c) 2016-2020 ReproMan Team |
| 38 | +to help you prepare and upload your data to, or obtain data from, the [DANDI archive](http://dandiarchive.org). |
| 39 | + |
| 40 | +Run `dandi --help` or `dandi <subcommand> --help` (e.g. `dandi upload --help`) to see manual pages. |
125 | 41 |
|
126 | 42 | ## Resources |
127 | 43 |
|
128 | 44 | * To learn how to interact with the DANDI archive and for examples on how to use the DANDI Client in various use cases, |
129 | | -see [the handbook](https://www.dandiarchive.org/handbook/). |
| 45 | +see [the handbook](https://www.dandiarchive.org/handbook/) |
| 46 | + (specifically the sections on using the CLI to |
| 47 | +[download](https://www.dandiarchive.org/handbook/12_download/) and |
| 48 | +[upload](https://www.dandiarchive.org/handbook/13_upload/) `Dandisets`). |
130 | 49 |
|
131 | 50 | * To get help: |
132 | 51 | - ask a question: https://github.com/dandi/helpdesk/discussions |
|
0 commit comments