Man page - datalad-save(1)
Packages contains this manual
- datalad-download-url(1)
- datalad-no-annex(1)
- datalad-addurls(1)
- datalad-siblings(1)
- datalad-remove(1)
- datalad-drop(1)
- datalad-export-archive(1)
- datalad-export-archive-ora(1)
- datalad-create-sibling-gogs(1)
- datalad-push(1)
- datalad-create-sibling-gitea(1)
- datalad-copy-file(1)
- datalad-sshrun(1)
- datalad-subdatasets(1)
- datalad-check-dates(1)
- datalad-create-sibling-gitlab(1)
- datalad-clone(1)
- datalad-create-test-dataset(1)
- datalad-wtf(1)
- datalad-create-sibling-github(1)
- datalad-shell-completion(1)
- datalad-uninstall(1)
- datalad-create-sibling-gin(1)
- datalad-configuration(1)
- datalad-update(1)
- datalad-get(1)
- datalad(1)
- datalad-clean(1)
- datalad-create-sibling-ria(1)
- datalad-rerun(1)
- datalad-create(1)
- datalad-unlock(1)
- datalad-status(1)
- datalad-run(1)
- datalad-foreach-dataset(1)
- datalad-install(1)
- datalad-add-archive-content(1)
- datalad-create-sibling(1)
- datalad-run-procedure(1)
- datalad-save(1)
- datalad-diff(1)
- datalad-add-readme(1)
- datalad-export-to-figshare(1)
apt-get install datalad
Manual
datalad save
NAMESYNOPSIS
DESCRIPTION
Examples
OPTIONS
AUTHORS
NAME
datalad save - save the current state of a dataset
SYNOPSIS
|
datalad save [-h] [-m MESSAGE] [-d DATASET] [-t ID] [-r] [-R LEVELS] [-u] [-F MESSAGE_FILE] [--to-git] [-J NJOBS] [--amend] [--version] [PATH ...] |
DESCRIPTION
Saving the state of a dataset records changes that have been made to it. This change record is annotated with a user-provided description. Optionally, an additional tag, such as a version, can be assigned to the saved state. Such tag enables straightforward retrieval of past versions at a later point in time.
|
NOTE |
Before Git v2.22, any Git repository without an initial commit located inside a Dataset is ignored, and content underneath it will be saved to the respective superdataset. DataLad datasets always have an initial commit, hence are not affected by this behavior. |
Examples
Save any content underneath the current directory, without altering any potential subdataset::
% datalad save .
Save specific content in the dataset::
% datalad save myfile.txt
Attach a commit message to save::
% datalad save -m âadd fileâ myfile.txt
Save any content underneath the current directory, and recurse into any potential subdatasets::
% datalad save . -r
Save any modification of known dataset content in the current directory, but leave untracked files (e.g. temporary files) untouched::
% datalad save -u .
Tag the most recent saved state of a dataset::
% datalad save --version-tag âbestyetâ
Save a specific change but integrate into last commit keeping the already recorded commit message::
% datalad save myfile.txt --amend
OPTIONS
|
PATH |
path/name of the dataset component to save. If given, only changes made to those components are recorded in the new state. Constraints: value must be a string or value must be NONE |
-h , --help , --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-m MESSAGE, --message MESSAGE
a description of the state or the changes made to a dataset. Constraints: value must be a string or value must be NONE
-d DATASET , --dataset DATASET
"specify the dataset to save. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) or value must be NONE
-t ID, --version-tag ID
an additional marker for that state. Every dataset that is touched will receive the tag. Constraints: value must be a string or value must be NONE
-r , --recursive
if set, recurse into potential subdatasets.
-R LEVELS, --recursion-limit LEVELS
limit recursion into subdatasets to the given number of levels. Constraints: value must be convertible to type âintâ or value must be NONE
-u , --updated
if given, only saves previously tracked paths.
-F MESSAGE_FILE , --message-file MESSAGE_FILE
take the commit message from this file. This flag is mutually exclusive with -m. Constraints: value must be a string or value must be NONE
--to-git
flag whether to add data directly to Git, instead of tracking data identity only. Use with caution, there is no guarantee that a file put directly into Git like this will not be annexed in a subsequent save operation. If not specified, it will be up to git-annex to decide how a file is tracked, based on a datasetâs configuration to track particular paths, file types, or file sizes with either Git or git-annex. (see https://git-annex.branchable.com/tips/largefiles).
-J NJOBS, --jobs NJOBS
how many parallel jobs (where possible) to use. "auto" corresponds to the number defined by âdatalad.runtime.max-annex-jobsâ configuration item NOTE: This option can only parallelize input retrieval (get) and output recording (save). DataLad does NOT parallelize your scripts for you. Constraints: value must be convertible to type âintâ or value must be NONE or value must be one of (âautoâ,)
--amend
if set, changes are not recorded in a new, separate commit, but are integrated with the changeset of the previous commit, and both together are recorded by replacing that previous commit. This is mutually exclusive with recursive operation.
--version
show the module and its version which provides the command
AUTHORS
datalad is developed by The DataLad Team and Contributors <team@datalad.org>.