git-annex-fsck(1)

📦
version 10.20261026 · 5 versions
, in alpine 3.24, arch rolling

✨ git-annex-fsck ✨

okay bestie, welcome to the git-annex manual page for fsck — your new favorite "find and fix problems" era 💅 this one's part of the general commands manual and honestly it's kind of the main character of repo hygiene 🎀

🌸 NAME 🌸

git-annex-fsck — find and fix problems, no cap 🔍

🦋 SYNOPSIS 🦋

git annex fsck [path ...]

💖 DESCRIPTION 💖

So this command checks your annexed files for consistency, and then it warns you about any problems it found — or straight up fixes them. It's giving "the perfect complement to git fsck" ✨ like they're besties, fr fr.

By default, it checks all the annexed files in the current directory and all the subdirectories under it. But if you give it parameters, it only checks those specific files you named. periods, selective 🫶

The kind of problems fsck catches, lowkey a whole list:

  • files that have gotten corrupted 😭
  • files whose content has somehow become lost 💀
  • files that don't have the configured number of copies made yet (we're working on it)
  • keys that can be upgraded to a better format 👑

💅 OPTIONS 💅

  • --from=remote — Check a remote instead of your local repository. Heads up bestie: by default the files get copied from the remote so it can actually check their contents. That's an expensive transfer. If you want to dodge it and just verify that the remote still has the files it's expected to have, add --fast. iykyk 🌈
  • --fast — Skips the expensive checksum calculations. Also skips the expensive transfers when you're fscking a remote. godspeed ⭐
  • --incremental — Starts a new incremental fsck pass, and clears the records of all the files that were checked in the previous incremental fsck pass. fresh start energy 🧚
  • --more — Skips the files that were checked since the last incremental fsck pass was started. Real talk: before --incremental is used to start an incremental fsck pass, files that get checked are still recorded, so using this option will skip checking those files again. About resuming: it may redundantly check some files that were checked before. Any files that fsck found problems with before will get re-checked on resume. Also, checkpoints are made every 1000 files or every 5 minutes during a fsck, and it resumes from the last checkpoint — so if an incremental fsck gets interrupted using eg ctrl-c, it will recheck the files that didn't make it into the last checkpoint. annoying but fair 😭
  • --incremental-schedule=time — This makes a new incremental fsck start only a specified time period after the last incremental fsck was started. The time is in the form "10d" or "300h". Scenario time ✨ maybe you'd like to run a fsck for 5 hours at night, picking up each night where it left off. You'd like this to continue until all files have been fscked. And once it's done, you'd like a new fsck pass to start, but no more often than once a month. Then put this in a nightly cron job:
git annex fsck --incremental-schedule 30d --time-limit 5h
  • --numcopies=N — Overrides the normally configured number of copies. If you only want to verify data integrity while disregarding the required number of copies, use --numcopies=1. slay, minimal 🎀
  • --all, -A — Normally only the files in the currently checked out branch get fscked. This option causes all versions of all files to be fscked. icon behavior 👑 Also? This is the default behavior when running git-annex in a bare repository.
  • --branch=ref — Operate on files in the specified branch or treeish. 🦋
  • --unused — Operate on the files found by the last run of git-annex unused.
  • --failed — Operate on files that have recently failed to be transferred. we don't talk about them 🙈
  • --key=keyname — Use this option to fsck a specified key.
  • matching options — The git-annex-matching-options(1) can be used to control what to fsck. you're in control, bestie 💅
  • --jobs=N, -JN — Runs multiple fsck jobs in parallel. For example: -J4 Setting this to "cpus" will run one job per CPU core. max efficiency 🌈
  • --json — Enables JSON output. This is intended to be parsed by programs that use git-annex. Each line of output is a JSON object. nerdy and iconic 🖥️
  • --json-error-messages — Messages that would normally be output to standard error get included in the JSON instead. no lost lore ✨
  • --quiet — Like all git-annex commands, this option makes only error and warning messages be displayed. This is particularly useful with fsck, which normally displays all the files it's checking even when there's no problem with them. honestly bless this flag 🙏

Also the git-annex-common-options(1) can be used. yes, those too 💜

🎀 SEE ALSO 🎀

🌟 AUTHOR 🌟

Joey Hess <id@joeyh.name> — the legend himself 🫶

ok that's the whole page bestie, go fsck responsibly 💖

and that's a wrap on git-annex-fsck(1), from the git-annex source, dated with all the usual manual-page timestamp energy — catch you in the next page, mwah 🎀✨💅

📦 where this page comes from