Repository files navigation

Manage and sync multiple git, svn, and mercurial repos via JSON or YAML file. Compare tomyrepos,mu-repo. Built onlibvcs.

Great if you use the same repos at the same locations across multiplemachines or want to clone / update a pattern of repos without having tocd into each one.

• clone / update to the latest repos with$ vcspull
• use filters to specify a location, repo url or pattern in themanifest to clone / update
• supports svn, git, hg version control systems
• automatically checkout fresh repositories
• supportspip-style URL's(RFC3986-basedurlscheme)

See thedocumentation,configuration examples, andconfig generators.

$pip install --user vcspull

Or using uv:

$uv tool install vcspull

For one-time use without installation:

$uvx vcspull

You can test the unpublished version of vcspull before its released.

• pip:

  $pip install --user --upgrade --pre vcspull

• pipx:

  $pipx install --suffix=@next'vcspull' --pip-args'\--pre' --force

  Then usevcspull@next sync [config]....

• uv:

  $uv tool install --prerelease=allow vcspull

Add your repos to~/.vcspull.yaml. You can edit the file by hand or letvcspull add orvcspull discover create entries for you.

~/code/:flask:"git+https://github.com/mitsuhiko/flask.git"~/study/c:awesome:"git+git://git.naquadah.org/awesome.git"~/study/data-structures-algorithms/c:libds:"git+https://github.com/zhemao/libds.git"algoxy:repo:"git+https://github.com/liuxinyu95/AlgoXY.git"remotes:tony:"git+ssh://git@github.com/tony/AlgoXY.git"

(see the author's.vcspull.yaml,moreconfiguration)

$HOME/.vcspull.yaml and$XDG_CONFIG_HOME/vcspull/ (~/.config/vcspull) canbe used as a declarative manifest to clone your repos consistently acrossmachines. Subsequent syncs of initialized repos will fetch the latest commits.

Register a single repository by pointing at the checkout:

$vcspull add~/projects/libs/my-lib

• vcspull infers the name from the directory and detects theorigin remote.Pass--url when you need to record a different remote.
• Override the derived name with--name and the workspace root with-w/--workspace.
• --dry-run previews the update, while--yes skips the confirmation prompt.
• -f/--file selects an alternate configuration file.
• Append--no-merge if you prefer to review duplicate workspace rootsyourself instead of having vcspull merge them automatically.
• Follow withvcspull sync my-lib to clone or update the working tree after registration.

Have a directory tree full of cloned Git repositories? Scan and append them toyour configuration:

$vcspull discover~/code --recursive

The scan shows each repository before import unless you opt into--yes. Add-w ~/code/ to pin the resulting workspace root or-f to write somewhere otherthan the default~/.vcspull.yaml. Duplicate workspace roots are merged bydefault; include--no-merge to keep them separate while you review the log.

List what vcspull already knows about without mutating anything:

$vcspull list$vcspull list --tree$vcspull list --json| jq'.[].name'

--json emits a single JSON array, while--ndjson streams newline-delimitedobjects that are easy to consume from shell pipelines.

Get a quick health check for all configured workspaces:

$vcspull status$vcspull status --detailed$vcspull status --ndjson| jq --slurp'map(select(.reason == "summary"))'

The status command respects--workspace/-w filters and the global--color {auto,always,never} flag. JSON and NDJSON output mirrors the listcommand for automation workflows.

After importing or editing by hand, run the formatter to tidy up keys, mergeduplicate workspace sections, and keep entries sorted:

$vcspull fmt -f~/.vcspull.yaml --write

Usevcspull fmt --all --write to format every YAML file that vcspull candiscover under the standard config locations. Add--no-merge if you only wantduplicate roots reported, not rewritten.

$vcspull sync

Preview planned work with Terraform-style plan output or emit structured datafor CI/CD:

$vcspull sync --dry-run"*"$vcspull sync --dry-run --show-unchanged"workspace-*"$vcspull sync --dry-run --json"*"| jq'.summary'$vcspull sync --dry-run --ndjson"*"| jq --slurp'map(select(.type == "summary"))'

Dry runs stream a progress line when stdout is a TTY, then print a concise plansummary (+/~/✓/⚠/✗) grouped by workspace. Use--summary-only,--relative-paths,--long, or-v/-vv for alternate views, and--fetch/--offline to control how remote metadata is refreshed.

Keep nested VCS repositories updated too, lets say you have a mercurialor svn project with a git dependency:

external_deps.yaml in your project root (any filename will do):

./vendor/:sdl2pp:"git+https://github.com/libSDL2pp/libSDL2pp.git"

Clone / update repos via config file:

$vcspull sync -f external_deps.yaml'*'

See theQuickstart formore.

Have a lot of repos?

you can choose to update only select repos throughfnmatchpatterns. remember to add the repos to your~/.vcspull.{json,yaml}first.

The patterns can be filtered by by directory, repo name or vcs url.

Any repo starting with "fla":

$vcspull sync"fla*"

Any repo with django in the name:

$vcspull sync"*django*"

Search by vcs + url, since urls are in this format +://:

$vcspull sync"git+*"

Any git repo with python in the vcspull:

$vcspull sync"git+*python*

Any git repo with django in the vcs url:

$vcspull sync"git+*django*"

All repositories in your ~/code directory:

$vcspull sync"$HOME/code/*"

Your donations fund development of new features, testing and support.Your money will go directly to maintenance and development of theproject. If you are an individual, feel free to give whatever feelsright for the value you get out of the project.

See donation options athttps://tony.sh/support.html.

• Python support: >= 3.10, pypy
• VCS supported: git(1), svn(1), hg(1)
• Source:https://github.com/vcs-python/vcspull
• Docs:https://vcspull.git-pull.com
• Changelog:https://vcspull.git-pull.com/history.html
• API:https://vcspull.git-pull.com/api.html
• Issues:https://github.com/vcs-python/vcspull/issues
• Test Coverage:https://codecov.io/gh/vcs-python/vcspull
• pypi:https://pypi.python.org/pypi/vcspull
• Open Hub:https://www.openhub.net/p/vcspull
• License:MIT.