PATH path to constrain the report to. 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
-f REVISION, --from REVISION
original state to compare to, as given by any identifier that Git understands. Constraints: value
must be a string [Default: 'HEAD']
-t REVISION, --to REVISION
state to compare against the original state, as given by any identifier that Git understands. If
none is specified, the state of the working tree will be compared. Constraints: value must be a
string or value must be NONE
-dDATASET, --datasetDATASET
specify the dataset to query. If no dataset is given, an attempt is made to identify the dataset
based on the current working directory. Constraints: Value must be a Dataset or a valid identifier
of a Dataset (e.g. a path) or value must be NONE
--annex [{basic|availability|all}]
Switch whether to include information on the annex content of individual files in the status re‐
port, such as recorded file size. By default no annex information is reported (faster). Three re‐
port modes are available: basic information like file size and key name ('basic'); additionally
test whether file content is present in the local annex ('availability'; requires one or two addi‐
tional file system stat calls, but does not call git-annex), this will add the result properties
'has_content' (boolean flag) and 'objloc' (absolute path to an existing annex object file); or
'all' which will report all available information (presently identical to 'availability'). The
'basic' mode will be assumed when this option is given, but no mode is specified. Constraints:
value must be one of ('basic', 'availability', 'all')
--untracked {no|normal|all}
If and how untracked content is reported when comparing a revision to the state of the working
tree. 'no': no untracked content is reported; 'normal': untracked files and entire untracked di‐
rectories are reported as such; 'all': report individual files even in fully untracked directo‐
ries. Constraints: value must be one of ('no', 'normal', 'all') [Default: 'normal']
-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 con‐
vertible to type 'int' or value must be NONE
--version
show the module and its version which provides the command