git-annex/doc/git-annex-add.mdwn

78 lines
1.7 KiB
Text
Raw Normal View History

# NAME
git-annex add - adds files to the git annex
# SYNOPSIS
git annex add `[path ...]`
# DESCRIPTION
Adds files in the path to the annex. If no path is specified, adds
files from the current directory and below.
2015-12-15 18:07:54 +00:00
Files that are already checked into git and are unmodified, or that
git has been configured to ignore will be silently skipped.
2015-12-15 18:07:54 +00:00
If annex.largefiles is configured, and does not match a file, `git annex
add` will behave the same as `git add` and add the non-large file directly
to the git repository, instead of to the annex.
2015-12-15 18:07:54 +00:00
Large files are added to the annex in locked form, which prevents further
modification of their content unless unlocked by [[git-annex-unlock]](1).
2015-12-15 18:17:34 +00:00
(This is not the case however when a repository is in direct mode.)
2015-12-15 18:07:54 +00:00
To add a file to the annex in unlocked form, `git add` can be used instead
(that only works when the repository has annex.version 6 or higher).
2015-12-15 18:14:19 +00:00
This command can also be used to add symbolic links, both symlinks to
annexed content, and other symlinks.
# OPTIONS
* `--include-dotfiles`
Dotfiles are skipped unless explicitly listed, or unless this option is
used.
* `--force`
Add gitignored files.
* `--backend`
Specifies which key-value backend to use.
* file matching options
Many of the [[git-annex-matching-options]](1)
can be used to specify files to add.
For example: `--largerthan=1GB`
2015-11-05 22:24:15 +00:00
* `--jobs=N` `-JN`
Adds multiple files in parallel. This may be faster.
For example: `-J4`
# SEE ALSO
[[git-annex]](1)
[[git-annex-unlock]](1)
[[git-annex-lock]](1)
[[git-annex-undo]](1)
[[git-annex-import]](1)
[[git-annex-unannex]](1)
[[git-annex-reinject]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.