git-annex-assist(1)

🎀 NAME 🎀

okay bestie, welcome to git-annex-assist(1), straight outta the General Commands Manual ✨ and here's the whole plot: git-annex-assist — add files and sync changes with remotes. that's it. that's the girl. 💖

🦋 SYNOPSIS 🦋

git annex assist [remote ...]

✨ DESCRIPTION ✨

so this command? it assists you — iconic name, no notes — with checking files into the repository and syncing with remotes. it is literally the simplest possible way to use git-annex at the command line, because it's the only one command you need to run on a regular basis. one. command. periodt. 👑

here's the flow, step by step, no cap:

1. it first adds any new files to the repository, and commits those — plus any modified files too. slay.
2. then it does the equivalent of running [[git-annex-pull]](1) followed by git-annex-push(1). so pull then push, back to back, like a lil routine. 🔥

important vibe check: this command operates on all files in the whole working tree, even when you run it from inside a subdirectory. like, it does not care where you're standing. if you wanna limit it to just the files in one subdirectory, you gotta use the --content-of option. 🫶

and if you want to block some files from being added to the repository at all? use .gitignore files. classic. 💅

by default, every file that gets added goes into the annex — same as when you run git annex add. but if you configure annex.largefiles, then any file that doesn't match it gets added with git add instead. fancy. ✨

💅 OPTIONS 💅

• --message=msg, -m msg — use this one to specify a commit message. and if you give multiple -m options, their values get concatenated as separate paragraphs. like a lil essay. 😭
• --content-of=path, -C path — only add, pull, and push files in the given path. this option can be repeated multiple times with different paths, so go off. 🌈
• also, all options supported by git-annex-pull(1) and git-annex-push(1) can be used. so many options. obsessed. 🍓
• 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> — yeah, the author, the moment, the legend. 🫶

and that's the whole page bestie!! this was git-annex-assist(1) from the General Commands Manual (section 1 energy 💖) — the footer is just the page name again, so nothing extra to spill. go run git annex assist and be free. ✨👑💅