Debian Codegraph @

docs/source/cmdline.rst

raw
1 .. -*- mode: rst -*-
2 .. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79:
3
4 .. _chap_cmdline:
5
6 **********************
7 Command line reference
8 **********************
9
10 Main command
11 ============
12
13 .. toctree::
14 :maxdepth: 1
15
16 datalad: Main command entrypoint <generated/man/datalad>
17
18 Core commands
19 =============
20
21 A minimal set of commands that cover essential functionality. Core commands
22 receive special scrutiny with regard API composition and (breaking) changes.
23
24 Local operation
25 ---------------
26
27 .. toctree::
28 :maxdepth: 1
29
30 datalad create: Create a new dataset <generated/man/datalad-create>
31 datalad save: Save the state of a dataset <generated/man/datalad-save>
32 datalad run: Run a shell command and record its impact on a dataset <generated/man/datalad-run>
33 datalad status: Report on the state of dataset content <generated/man/datalad-status>
34 datalad diff: Report differences between two states of a dataset <generated/man/datalad-diff>
35
36 Distributed operation
37 ---------------------
38
39 .. toctree::
40 :maxdepth: 1
41
42 datalad clone: Obtain a dataset (sibling) from another location <generated/man/datalad-clone>
43 datalad push: Push updates/data to a dataset sibling <generated/man/datalad-push>
44
45
46 Extended set of functionality
47 =============================
48
49 Dataset operations
50 ------------------
51
52 .. toctree::
53 :maxdepth: 1
54
55 datalad add-readme: Add information on DataLad dataset to a README <generated/man/datalad-add-readme>
56 datalad addurls: Update dataset content from a list of URLs <generated/man/datalad-addurls>
57 datalad copy-file: Copy file identity and availability from one dataset to another <generated/man/datalad-copy-file>
58 datalad drop: Drop datasets or dataset components <generated/man/datalad-drop>
59 datalad get: Obtain any dataset content <generated/man/datalad-get>
60 datalad install: Install a dataset from a (remote) source <generated/man/datalad-install>
61 datalad no-annex: Configure a dataset to never put file content into an annex <generated/man/datalad-no-annex>
62 datalad remove: Unlink components from a dataset <generated/man/datalad-remove>
63 datalad subdatasets: Query and manipulate subdataset records of a dataset <generated/man/datalad-subdatasets>
64 datalad unlock: Make dataset file content editable <generated/man/datalad-unlock>
65
66
67 Dataset siblings and 3rd-party platform support
68 -----------------------------------------------
69
70 .. toctree::
71 :maxdepth: 1
72
73 datalad siblings: Query and manipulate sibling configuration of a dataset <generated/man/datalad-siblings>
74 datalad create-sibling: Create a sibling on an SSH-accessible machine <generated/man/datalad-create-sibling>
75 datalad create-sibling-github: Create a sibling on GitHub <generated/man/datalad-create-sibling-github>
76 datalad create-sibling-gitlab: Create a sibling on GitLab <generated/man/datalad-create-sibling-gitlab>
77 datalad create-sibling-gogs: Create a sibling on GOGS <generated/man/datalad-create-sibling-gogs>
78 datalad create-sibling-gitea: Create a sibling on Gitea <generated/man/datalad-create-sibling-gitea>
79 datalad create-sibling-gin: Create a sibling on GIN (with content hosting) <generated/man/datalad-create-sibling-gin>
80 datalad create-sibling-ria: Create a sibling in a RIA store <generated/man/datalad-create-sibling-ria>
81 datalad export-archive: Export dataset content as a TAR/ZIP archive <generated/man/datalad-export-archive>
82 datalad export-archive-ora: Export a local dataset annex for the ORA remote <generated/man/datalad-export-archive-ora>
83 datalad export-to-figshare: Export dataset content as a ZIP archive to figshare <generated/man/datalad-export-to-figshare>
84 datalad update: Obtain and incorporate updates from dataset siblings <generated/man/datalad-update>
85
86
87 Reproducible execution
88 ----------------------
89
90 Extending the functionality of the core ``run`` command.
91
92 .. toctree::
93 :maxdepth: 1
94
95 datalad rerun: Re-execute previous datalad-run commands <generated/man/datalad-rerun>
96 datalad run-procedure: Run prepared procedures (DataLad scripts) on a dataset <generated/man/datalad-run-procedure>
97
98
99 Helpers and support utilities
100 -----------------------------
101
102 .. toctree::
103 :maxdepth: 1
104
105 datalad add-archive-content: Extract and add the content of an archive to a dataset <generated/man/datalad-add-archive-content>
106 datalad clean: Remove temporary left-overs of DataLad operations <generated/man/datalad-clean>
107 datalad check-dates: Scan a dataset for dates and timestamps <generated/man/datalad-check-dates>
108 datalad configuration: Get and set configuration <generated/man/datalad-configuration>
109 datalad create-test-dataset: Test helper <generated/man/datalad-create-test-dataset>
110 datalad download-url: Download helper with support for DataLad's credential system <generated/man/datalad-download-url>
111 datalad foreach-dataset: Run a command or Python code on the dataset and/or each of its sub-datasets <generated/man/datalad-foreach-dataset>
112 datalad sshrun: Remote command execution using DataLad's connection management <generated/man/datalad-sshrun>
113 datalad shell-completion: Helper to support command completion <generated/man/datalad-shell-completion>
114 datalad wtf: Report on a DataLad installation and its configuration <generated/man/datalad-wtf>
115
116
117 Deprecated commands
118 -------------------
119
120 .. toctree::
121 :maxdepth: 1
122
123 datalad uninstall: Drop subdatasets <generated/man/datalad-uninstall>