git-annex/doc/git-annex-assist.mdwn
Joey Hess e955912ad0
git-annex assist
assist: New command, which is the same as git-annex sync but with
new files added and content transferred by default.

(Also this fixes another reversion in git-annex sync,
--commit --no-commit, and --message were not enabled, oops.)

See added comment for why git-annex assist does commit staged
changes elsewhere in the work tree, but only adds files under
the cwd.

Note that it does not support --no-commit, --no-push, --no-pull
like sync does. My thinking is, why should it? If you want that
level of control, use git commit, git annex push, git annex pull.
Sync only got those options because pull and push were not split
out.

Sponsored-by: k0ld on Patreon
2023-05-18 14:37:43 -04:00

57 lines
1.3 KiB
Markdown

# NAME
git-annex assist - add files and sync changes with remotes
# SYNOPSIS
git annex assist `[remote ...]`
# DESCRIPTION
This command assists you in checking files into the repository
and syncing with remotes. It's the simplest possible way to use git-annex
at the command line, since only this one command needs to be run on a
regular basis.
This command first adds any new files (in the current directory and
its children) to the repository, and commits those as well as any
modified files. Then it does the equivilant of running
[[git-annex-pull](1) followed by [[git-annex-push]](1).
To block some files from being added to the repository, use `.gitignore`
files.
By default, all files that are added are added to the annex, the same
as when you run `git annex add`. If you configure annex.largefiles,
files that it does not match will instead be added with `git add`.
# OPTIONS
* `--message=msg`
Use this option to specify a commit message.
* Also all options supported by [[git-annex-pull]](1) and
[[git-annex-push]](1) can be used.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
[[git-annex-add]](1)
[[git-annex-pull]](1)
[[git-annex-push]](1)
[[git-annex-sync]](1)
[[git-annex-assistant]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.