git-annex-addcomputed(1)

πŸ’– git-annex-addcomputed πŸ’–

okay so bestie, welcome to the General Commands Manual entry for git-annex-addcomputed, and babes, it's giving "let the computer do the crafting" ✨


🌸 NAME 🌸

git-annex-addcomputed β€” adds computed files to the repository 🧚


πŸŽ€ SYNOPSIS πŸŽ€

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

πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the tea: this command adds files to the annex that are computed from input files already in the repository, using a compute special remote. No cap. πŸ”₯

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. literally magic πŸ’…

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 computation. so like, that part is not on git-annex, that's the program's whole personality.

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. multitasking queen πŸ‘‘

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
heads up bestie: 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. they're coming along whether you invited them or not 😭

✨ 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. the procrastination option, we respect it πŸ’€

This implies --unreproducible, because even if the compute remote produces reproducible output, it's not available. (you can't have the reproducibility if nobody did the computing, babe.)

πŸ’« --unreproducible, -u

Indicate that the computation is not expected to be fully reproducible. It can vary, in ways that produce files that are equivalent 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).

okay serious moment: 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. noted and screenshotted πŸ“Έ

πŸ’« --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. (yep, the whole shared options squad 🫢)


πŸ‘‘ SEE ALSO πŸ‘‘


🌈 AUTHOR 🌈

Joey Hess <id@joeyh.name>


and that's the whole page bestie, from the git-annex manual pages, git-annex-addcomputed(1), General Commands Manual β€” no version, no date, just vibes and a very good command. πŸŽ€πŸ’– go compute something iconic, ily, bye!! πŸ¦‹βœ¨