git-annex/doc/git-annex-findcomputed.mdwn
Joey Hess 74457b6b93
findcompute --inputs
Useful for eg, generating dependency graphs.
2025-03-19 15:39:05 -04:00

101 lines
2.5 KiB
Markdown

# NAME
git-annex findcomputed - lists computed files
# SYNOPSIS
git annex findcomputed `[path ...]`
# DESCRIPTION
Outputs a list of files in the specified path that can be computed by
enabled compute special remotes. With no path, lists files in the current
directory and its subdirectories.
Along with the name of each computed file, this displays the input that
was provided to [[git-annex-addcomputed]](1).
For example:
# git-annex findcomputed
foo.jpeg (imageconvert) -- convert file.raw file.jpeg passes=10
bar.gz (compressor) -- compress bar --level=9
# OPTIONS
* matching options
The [[git-annex-matching-options]](1)
can be used to specify files to list.
* `--branch=ref`
List computed files in the specified branch or treeish.
* `--inputs`
Display each computed file followed by the input that is used to
produce it. The current location of the input file in the work tree is
displayed, but if the input file is not in the work tree, the key
is displayed instead.
For example:
foo.jpeg file.raw
bar.gz bar
When multiple input files are needed to compute a file, outputs multiple
lines for that file:
foo bar
foo baz
* `--format=value`
Use custom output formatting.
This option works the same as in [[git-annex-find]](1), with these
additional variables available for use in it:
"${remote}", "${computation}"
The default output format is the same as
`--format='${file} (${remote}) -- ${computation}\\n'`,
except when outputting to a terminal, control characters will be escaped.
When `--inputs` is used, there are additional variables "${inputfile}"
which is the input filename, "${inputkey}" which is the input key,
and "${input}" which is either the filename or the key.
The default output format for `--inputs`
is the same as `--format='${file} ${input}\\n'`
To separate the pair of files by nulls instead, use eg
`--format='${file}\\000${input}\\n'
* `--json`
Output the list of files in JSON format.
This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
* `--json-error-messages`
Messages that would normally be output to standard error are included in
the JSON instead.
# SEE ALSO
[[git-annex]](1)
[[git-annex-addcomputed]](1)
[[git-annex-recompute]](1)
[[git-annex-findcomputed]](1)
[[git-annex-find]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.