WEBCHECKOUT(1)

πŸ’– WEBCHECKOUT(1) πŸ’–

okay bestie, welcome to webcheckout β€” it's a little manual page (section 1, the user commands one 🫢) and honestly? it's giving "clone literally everything on this webpage at once." iconic behaviour, no notes.


✨ NAME ✨

webcheckout β€” check out repositories referenced on a web page πŸŒπŸ’…


🌸 SYNOPSIS 🌸

webcheckout [options] url [destdir]

πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the vibe. webcheckout downloads a url and parses it, looking for version control repositories referenced by that page πŸ‘€. then it checks out each repository into a subdirectory of the current directory, using whatever VCS program is appropriate for that repository (git, svn, etc.). yes, it just. does that. for you. main character energy fr fr πŸ‘‘

the information about the repositories is embedded in the web page using the rel=vcs-* microformat, which is documented at https://joeyh.name/rfc/rel-vcs/ πŸ“œβœ¨

and if you pass the optional destdir parameter? then VCS programs will be asked to check out repositories into that directory instead. and if there are multiple repositories to check out, each one gets checked out into a separate subdirectory of the destdir πŸ—‚οΈπŸŒΈ (so like, no fighting, everybody gets their own room, we love a boundaries moment)


πŸ’… OPTIONS πŸ’…

  • -a, --auth β€” prefer authenticated repositories πŸ’œ. by default, webcheckout will use anonymous repositories when possible. but if you have an account that allows you to use authenticated repositories, you might want to use this option. iykyk πŸ”
  • --no-act, -n β€” do not actually check anything out, just print out the commands that would be run to check out the repositories 🫣. it's giving "window shopping" and honestly it's a great way to vibe check before committing
  • --quiet, -q β€” quiet mode 🀫. do not print out the commands being run. (the VCS commands may still be noisy however. not me being loud in the group chat while you're on mute 😭)

πŸŽ€ PREREQUISITES πŸŽ€

to use this program you will need lots of VCS programs installed, obviously πŸ™„βœ¨. it also depends on the perl LWP and HTML::Parser modules.

and here's a lil bonus: if the perl URI module is installed, webcheckout can heuristically guess what you mean by partial URLs, such as "kitenet.net/~joey" πŸ§šπŸ’« (guess queen)


πŸ‘‘ AUTHOR πŸ‘‘

Copyright 2009 Joey Hess <joey@kitenet.net> πŸ’–

Licensed under the GNU GPL version 2 or higher. πŸ“„

This program is included in myrepos https://myrepos.branchable.com/ 🌈


ok that's the whole page, you're fully caught up, go check out some repos bestie 🫢

this lil doc was generated by perl v5.40.1 and dated 2025-11-24 β€” thanks for coming to my ted talk, mwah πŸ’‹β­

πŸ“¦ where this page comes from