| 1 |
.. The content of this file was auto-generated by your mad uncle from Germany |
| 2 |
using the cast2rst script and a recorded asciicast as input. |
| 3 |
|
| 4 |
Do not edit this file! |
| 5 |
|
| 6 |
|
| 7 |
|
| 8 |
All of DataLad's functionality is available through a single command: |
| 9 |
`datalad` |
| 10 |
|
| 11 |
Running the datalad command without any arguments, gives a summary |
| 12 |
of basic options, and a list of available sub-commands. |
| 13 |
|
| 14 |
.. code-block:: ansi-color |
| 15 |
|
| 16 |
[1;36m~[0m % datalad |
| 17 |
usage: datalad [-h] [-l LEVEL] [-C PATH] [--version] |
| 18 |
[--dbg] [--idbg] [-c KEY=VALUE] |
| 19 |
[-f {default,json,json_pp,tailored,'<template>'}] |
| 20 |
[--report-status {success,failure,ok,notneeded,impossible,error}] |
| 21 |
[--report-type {dataset,file}] |
| 22 |
[--on-failure {ignore,continue,stop}] [--cmd] |
| 23 |
{create,install,get,publish,uninstall,drop,remove,update,create-sibling,create-sibling-github,unlock,save,search,metadata,aggregate-metadata,test,ls,clean,add-archive-content,download-url,run,rerun,addurls,export-archive,extract-metadata,export-to-figshare,no-annex,wtf,add-readme,annotate-paths,clone,create-test-dataset,diff,siblings,sshrun,subdatasets} |
| 24 |
... |
| 25 |
[[1;31mERROR [0m] Please specify the command |
| 26 |
[0m[1;36m~[0m % # |
| 27 |
|
| 28 |
More comprehensive information is available via the --help |
| 29 |
long-option (we will truncate the output here) |
| 30 |
|
| 31 |
.. code-block:: ansi-color |
| 32 |
|
| 33 |
[1;36m~[0m % datalad --help | head -n20 |
| 34 |
Usage: datalad [global-opts] command [command-opts] |
| 35 |
|
| 36 |
DataLad provides a unified data distribution with the convenience of git-annex |
| 37 |
repositories as a backend. DataLad command line tools allow to manipulate |
| 38 |
(obtain, create, update, publish, etc.) datasets and their collections. |
| 39 |
|
| 40 |
*Commands for dataset operations* |
| 41 |
|
| 42 |
create |
| 43 |
Create a new dataset from scratch |
| 44 |
install |
| 45 |
Install a dataset from a (remote) source |
| 46 |
get |
| 47 |
Get any dataset content (files/directories/subdatasets) |
| 48 |
publish |
| 49 |
Publish a dataset to a known sibling |
| 50 |
uninstall |
| 51 |
Uninstall subdatasets |
| 52 |
|
| 53 |
|
| 54 |
Getting information on any of the available sub commands works |
| 55 |
in the same way -- just pass --help AFTER the sub-command (output |
| 56 |
again truncated) |
| 57 |
|
| 58 |
.. code-block:: ansi-color |
| 59 |
|
| 60 |
[1;36m~[0m % datalad create --help | head -n20 |
| 61 |
Usage: datalad create [-h] [-f] [-D DESCRIPTION] [-d PATH] [--no-annex] |
| 62 |
[--nosave] [--annex-version ANNEX_VERSION] |
| 63 |
[--annex-backend ANNEX_BACKEND] |
| 64 |
[--native-metadata-type LABEL] [--shared-access MODE] |
| 65 |
[--git-opts STRING] [--annex-opts STRING] |
| 66 |
[--annex-init-opts STRING] [--text-no-annex] |
| 67 |
[PATH] |
| 68 |
|
| 69 |
Create a new dataset from scratch. |
| 70 |
|
| 71 |
This command initializes a new dataset at a given location, or the |
| 72 |
current directory. The new dataset can optionally be registered in an |
| 73 |
existing superdataset (the new dataset's path needs to be located |
| 74 |
within the superdataset for that, and the superdataset needs to be given |
| 75 |
explicitly). It is recommended to provide a brief description to label |
| 76 |
the dataset's nature *and* location, e.g. "Michael's music on black |
| 77 |
laptop". This helps humans to identify data locations in distributed |
| 78 |
scenarios. By default an identifier comprised of user and machine name, |
| 79 |
plus path will be generated. |
| 80 |
|
| 81 |
|
| 82 |
|
| 83 |
______________________________________ |
| 84 |
/ Demo was using datalad 0.9.2.dev803. \ |
| 85 |
\ Discover more at http://datalad.org / |
| 86 |
-------------------------------------- |
| 87 |
\ ^__^ |
| 88 |
\ (oo)\_______ |
| 89 |
(__)\ )\/\ |
| 90 |
||----w | |
| 91 |
|| || |
| 92 |
|
| 93 |
|
| 94 |
.. code-block:: ansi-color |
| 95 |
|
| 96 |
[1;36m~[0m % d[Kexit |