git-annex-map(1)

πŸ’– NAME πŸ’–

okay bestie, welcome to git-annex-map(1) from the General Commands Manual β€” this is the page for git-annex-map - generate map of repositories. Literally its whole job is making a map of your repos, and I'm obsessed. πŸ—ΊοΈβœ¨

✨ SYNOPSIS ✨

git annex map

πŸ—ΊοΈ DESCRIPTION πŸ—ΊοΈ

This command helps you keep track of your repositories, and the connections between them, by going out and looking at all the ones it can get to, and generating a Graphviz file displaying it all. Slay. πŸ’… If the xdot command is available, it is used to display the file to your screen.

This command only connects to hosts that the host it's run on can directly connect to. It does not try to tunnel through intermediate hosts. So it might not show all connections between the repositories in the network. Lowkey important. 🫢

Also, if connecting to a host requires a password, you might have to enter it several times as the map is being built. Annoying but true, bestie. 😭

Note that this subcommand can be used to graph any git repository; it is not limited to git-annex repositories. Iconic. 🌈

🎨 LEGEND 🎨

Ovals are repositories. White is regular, green is trusted, red is untrusted, and grey is dead. Color-coded queen behavior. πŸ‘‘

Arrows between repositories are connections via git remotes. 🏹

Light blue boxes are hosts that were mapped, and contain the repositories on that host. 🩡

βš™οΈ OPTIONS βš™οΈ

  • --fast β€” Don't display the generated Graphviz file, but save it for later use. Save it for later, iykyk. πŸ’Ύ
  • --json β€” Output the map as a JSON object. JSON girlies rise. 🧚

Also the git-annex-common-options(1) can be used.

πŸ‘€ SEE ALSO πŸ‘€

πŸ‘‘ AUTHOR πŸ‘‘

Joey Hess <id@joeyh.name> β€” author icon. πŸ’œ


And that's the whole page, bestie! Cute footer sign-off: the source/version/date situation is just git-annex-map(1) from the General Commands Manual, and the footer only shows git-annex-map(1) β€” no extra date or version number appears, so I'm not inventing one, periodt. πŸŽ€πŸ’–

πŸ“¦ where this page comes from