Your company here, and a link to your site. Click to find out more.

Package git-annex

Manage files with git, without checking their contents into git


Git-annex allows managing files with git, without checking the file contents
into git. While that may seem paradoxical, it is useful when dealing with files
larger than git can currently easily handle, whether due to limitations in
memory, time, or disk space.

It can store large files in many places, from local hard drives, to a large
number of cloud storage services, including S3, WebDAV, and rsync, with a dozen
cloud storage providers usable via plugins. Files can be stored encrypted with
gpg, so that the cloud storage provider cannot see your data.
git-annex keeps track of where each file is stored, so it knows how many copies
are available, and has many facilities to ensure your data is preserved.

git-annex can also be used to keep a folder in sync between computers, noticing
when files are changed, and automatically committing them to git and
transferring them to other computers. The git-annex webapp makes it easy to set
up and use git-annex this way.

Version: 10.20240227

See also: git, git-absorb, git-autofixup, git-cola, git-core-doc, git-cpan-patch, git-credential-azure, git-credential-oauth, git-crypt, git-cvs, git-daemon, git-email, git-extras, git-fame, git-filter-repo, git-ftp, git-gui, git-instaweb, git-lfs, git-merge-changelog, git-octopus, git-p4, git-publish, git-remote-gcrypt, git-remote-hg, git-review, git-revise, git-secret, git-secrets, git-subtree, git-svn, git-tools, git-xcleaner.

General Commands

git-annex manage files with git, without checking their contents in
git-annex-add adds files to the git annex
git-annex-addunused add back unused files
git-annex-addurl add urls to annex
git-annex-adjust enter an adjusted branch
git-annex-assist add files and sync changes with remotes
git-annex-assistant daemon to add files and automatically sync changes
git-annex-backends key/value backends for git-annex
git-annex-benchmark benchmark git-annex commands
git-annex-calckey calculate key for a file
git-annex-checkpresentkey check if key is present in remote
git-annex-common-options options supported by many git-annex commands
git-annex-config configuration stored in git-annex branch
git-annex-configremote changes special remote configuration
git-annex-contentlocation looks up content for a key
git-annex-copy copy content of files to/from another repository
git-annex-dead hide a lost repository or key
git-annex-describe change description of a repository
git-annex-diffdriver git diff driver
git-annex-direct switch repository to direct mode (deprecated)
git-annex-drop remove content of files from repository
git-annex-dropkey drops annexed content for specified keys
git-annex-dropunused drop unused file content
git-annex-edit unlock files for modification
git-annex-enable-tor enable tor hidden service
git-annex-enableremote enables git-annex to use a remote
git-annex-examinekey prints information from a key
git-annex-expire expire inactive repositories
git-annex-export export a tree of files to a special remote
git-annex-filter-branch filter information from the git-annex branch
git-annex-filter-process long running git filter process for git-annex
git-annex-find lists available files
git-annex-findkeys lists available keys
git-annex-findref lists files in a git ref (deprecated)
git-annex-fix fix up links to annexed content
git-annex-forget prune git-annex branch history
git-annex-fromkey adds a file using a specific key
git-annex-fsck find and fix problems
git-annex-fuzztest generates fuzz test files
git-annex-get make content of annexed files available
git-annex-group add a repository to a group
git-annex-groupwanted get or set groupwanted expression
git-annex-import import files from a special remote
git-annex-importfeed import files from podcast feeds
git-annex-indirect switch repository to indirect mode (deprecated)
git-annex-info information about an item or the repository
git-annex-init initialize git-annex
git-annex-initremote creates a special (non-git) remote
git-annex-inprogress access files while they're being downloaded
git-annex-list show which remotes contain files
git-annex-lock lock files to prevent modification
git-annex-log shows location log information
git-annex-lookupkey looks up key used for file
git-annex-map generate map of repositories
git-annex-matchexpression checks if an expression matches
git-annex-matching-expression specifying a set of files
git-annex-matching-options specifying what to act on
git-annex-merge merge changes from remotes
git-annex-metadata sets or gets metadata of a file
git-annex-migrate switch data to different backend
git-annex-mincopies configure minimum number of copies
git-annex-mirror mirror content of files to/from another repository
git-annex-move move content of files to/from another repository
git-annex-multicast multicast file distribution
git-annex-numcopies configure desired number of copies
git-annex-oldkeys list keys used for old versions of files
git-annex-p2p configure peer-2-peer links between repositories
git-annex-post-receive run by git post-receive hook
git-annex-pre-commit run by git pre-commit hook
git-annex-preferred-content which files are wanted in a repository
git-annex-proxy safely bypass direct mode guard (deprecated)
git-annex-pull pull content from remotes
git-annex-push push content to remotes
git-annex-readpresentkey read records of where key is present
git-annex-registerurl registers an url for a key
git-annex-reinit initialize repository, reusing old UUID
git-annex-reinject inject content of file back into annex
git-annex-rekey change keys used for files
git-annex-remotedaemon persistent communication with remotes
git-annex-renameremote changes name of a special remote
git-annex-repair recover broken git repository
git-annex-required get or set required content expression
git-annex-resolvemerge resolve merge conflicts
git-annex-restage restages unlocked files in the git index
git-annex-rmurl record file is not available at url
git-annex-satisfy transfer and drop content as configured
git-annex-schedule get or set scheduled jobs
git-annex-semitrust return repository to default trust level
git-annex-setkey sets annexed content for a key
git-annex-setpresentkey change records of where key is present
git-annex-shell Restricted login shell for git-annex only SSH access
git-annex-smudge git filter driver for git-annex
git-annex-status show the working tree status (deprecated)
git-annex-sync synchronize local repository with remotes
git-annex-test run built-in test suite
git-annex-testremote test transfers to/from a remote
git-annex-transferkey transfers a key from or to a remote
git-annex-transferkeys transfers keys (deprecated)
git-annex-transferrer transfers content
git-annex-trust trust a repository
git-annex-unannex undo accidental add command
git-annex-undo undo last change to a file or directory
git-annex-ungroup remove a repository from a group
git-annex-uninit de-initialize git-annex and clean out repository
git-annex-unlock unlock files for modification
git-annex-unregisterurl unregisters an url for a key
git-annex-untrust do not trust a repository
git-annex-unused look for unused file content
git-annex-upgrade upgrade repository
git-annex-vadd add subdirs to current view
git-annex-vcycle switch view to next layout
git-annex-version show version info
git-annex-vfilter filter current view
git-annex-vicfg edit configuration in git-annex branch
git-annex-view enter a view branch
git-annex-vpop switch back to previous view
git-annex-wanted get or set preferred content expression
git-annex-watch daemon to watch for changes
git-annex-webapp launch webapp
git-annex-whereis lists repositories that have file content
git-annex-whereused find what files use or used a key
git-remote-tor-annex remote helper program to talk to git-annex over tor