File: git-annex-addcomputed.mdwn

package info (click to toggle)
git-annex 10.20250416-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 73,572 kB
  • sloc: haskell: 90,656; javascript: 9,103; sh: 1,469; makefile: 211; perl: 137; ansic: 44
file content (110 lines) | stat: -rw-r--r-- 3,275 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# NAME

git-annex addcomputed - adds computed files to the repository

# SYNOPSIS

git annex addcomputed `--to=remote -- ...`

# DESCRIPTION

Adds files to the annex that are computed from input files in the
repository, using a compute special remote.

Once a file has been added to a compute remote, commands
like `git-annex get` will use it to compute the content of the file.

The syntax of this command after the `--` is up to the program that
the compute special remote is set up to run to perform the comuptation.

To see the program's usage, you can run:

    git-annex addcomputed --to=foo

Generally you will provide an input file (or files), and often also an
output filename, and additional parameters to control the computation.

There can be more than one input file that are combined to compute an
output file. And multiple output files can be computed at the same time.

Some examples of how this might look:

    git-annex addcomputed --to=x -- convert file.raw file.jpeg passes=10
    git-annex addcomputed --to=y -- compress foo --level=9
    git-annex addcomputed --to=z -- clip foo 2:01-3:00 combine with bar to baz

Note that parameters that were passed to `git-annex initremote` 
when setting up the compute special remote will be appended to the end of
the parameters provided to `git-annex addcomputed`.

# OPTIONS

* `--to=remote`

  Specify which remote will compute the files. 

  This must be a compute remote. For example, one can be
  initialized with:

    git-annex initremote photoconv type=compute \
        program=git-annex-compute-photoconv

  For details about compute remotes, and a list of some
  of the programs that are available, see
  <https://git-annex.branchable.com/special_remotes/compute/>

* `--fast`

  Adds computed files to the repository, without doing any work yet to
  compute their content.

  This implies `--unreproducible`, because even if the compute remote
  produces reproducible output, it's not available.

* `--unreproducible`, `-u`

  Indicate that the computation is not expected to be fully reproducible.
  It can vary, in ways that produce files that equivilant enough to
  be interchangeable, but are not necessarily identical.

  This is the default unless the compute remote indicates that it produces
  reproducible output.

* `--reproducible`, `-r`

  Indicate that the computation is expected to be fully reproducible.

  This is the default when the compute remote indicates that it produces
  reproducible output (except when using `--fast`).

  If a computation turns out not to be fully reproducible, then getting
  a computed file from the compute remote will later fail with a
  checksum verification error. One thing that can be done then is to use 
  `git-annex recompute --original --unreproducible`.

* `--backend`

  Specifies which key-value backend to use.

* `--json`

  Enable JSON output. This is intended to be parsed by programs that use
  git-annex. Each line of output is a JSON object.

*  Also the [[git-annex-common-options]](1) can be used.

# SEE ALSO

[[git-annex]](1)

[[git-annex-recompute]](1)

[[git-annex-findcomputed]](1)

[[git-annex-initremote]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.