Skip to main content

$ vcspull · Python Package License Code Coverage

Manage and sync multiple git, svn, and mercurial repos via JSON or YAML file. Compare to myrepos, mu-repo. Built on libvcs.

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

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

See the documentation, configuration examples, and config generators.

How to

Install

$ pip install --user vcspull

Or using uv:

$ uv tool install vcspull

For one-time use without installation:

$ uvx vcspull

Developmental releases

You can test the unpublished version of vcspull before it's released.

  • pip:

    $ pip install --user --upgrade --pre vcspull
    
  • pipx:

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

    Then use vcspull@next sync [config]....

  • uv:

    $ uv tool install --prerelease=allow vcspull
    

Configuration

Add your repos to ~/.vcspull.yaml. You can edit the file by hand or let vcspull add, vcspull discover, or vcspull import 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, more configuration)

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

Add repositories from the CLI

Register a single repository by pointing at the checkout:

$ vcspull add ~/projects/libs/my-lib
  • vcspull infers the name from the directory and detects the origin 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 roots yourself instead of having vcspull merge them automatically.
  • Follow with vcspull sync my-lib to clone or update the working tree after registration.

Discover local checkouts and add en masse

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

$ vcspull discover ~/code --recursive

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

Import from remote services

Pull repository lists from GitHub, GitLab, Codeberg, Gitea, Forgejo, or AWS CodeCommit directly into your configuration:

$ vcspull import github myuser \
    --workspace ~/code/ \
    --mode user
$ vcspull import gitlab my-group \
    --workspace ~/work/ \
    --mode org

Use --dry-run to preview changes, --https for HTTPS clone URLs, and --language/--topics/--min-stars to filter results. See the import documentation for all supported services and options.

Inspect configured repositories

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-delimited objects that are easy to consume from shell pipelines.

Search across repositories with an rg-like query syntax:

$ vcspull search django
$ vcspull search name:django url:github
$ vcspull search --fixed-strings 'git+https://github.com/org/repo.git'

Check repository status

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 list command for automation workflows.

Normalize configuration files

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

$ vcspull fmt \
    --file ~/.vcspull.yaml \
    --write

Use vcspull fmt --all --write to format every YAML file that vcspull can discover under the standard config locations. Add --no-merge if you only want duplicate roots reported, not rewritten.

Sync your repos

$ vcspull sync --all

Preview planned work with Terraform-style plan output or emit structured data for 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 plan summary (+/~/✓/⚠/✗) 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 — say you have a mercurial or 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 --file external_deps.yaml '*'

See the Quickstart for more.

Pulling specific repos

Have a lot of repos? Choose to update only select repos through fnmatch patterns. Add the repos to your ~/.vcspull.{json,yaml} first.

The patterns filter 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 vcs url:

$ 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/*"
image

Donations

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

See donation options at https://tony.sh/support.html.

More information

Docs Build Status

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vcspull-1.67.0.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vcspull-1.67.0-py3-none-any.whl (157.1 kB view details)

Uploaded Python 3

File details

Details for the file vcspull-1.67.0.tar.gz.

File metadata

  • Download URL: vcspull-1.67.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for vcspull-1.67.0.tar.gz
Algorithm Hash digest
SHA256 943f73be5cdfcf9714a332fb21421ff56881f12b54d592a685b7fe09b1c46c1e
MD5 79ace3edca3c962c192e95c904650f1a
BLAKE2b-256 6474aeed07e870f3a786e333ca80fc62013c4800b3a4a593aec9e71209cf1513

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcspull-1.67.0.tar.gz:

Publisher: tests.yml on vcs-python/vcspull

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vcspull-1.67.0-py3-none-any.whl.

File metadata

  • Download URL: vcspull-1.67.0-py3-none-any.whl
  • Upload date:
  • Size: 157.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for vcspull-1.67.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70c57f2ea8f3aabe92ae7200c6dd249060106b3b1767907d29832deceea148de
MD5 d9d0fa1a013f913e581d5ce9dccb1fcf
BLAKE2b-256 a1e1fe5c6641dbf5bb80b795353c78845604216741bdd25409905b8ceb550ce0

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcspull-1.67.0-py3-none-any.whl:

Publisher: tests.yml on vcs-python/vcspull

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.67.0 This release

2 files

1.66.0

2 files

1.65.0

2 files

1.64.0

2 files

1.63.0

2 files

1.62.0

2 files

1.61.0

2 files

1.60.1

2 files

1.60.0

2 files

1.59.0

2 files

1.58.1

2 files

1.58.0

2 files

1.57.0

2 files

1.56.1

2 files

1.56.0

2 files

1.55.0

2 files

1.54.0

2 files

1.53.0

2 files

1.52.1

2 files

1.52.0

2 files

1.51.1

2 files

1.51.0

2 files

1.50.1

2 files

1.50.0

2 files

1.49.0

2 files

1.48.1

2 files

1.48.0

2 files

1.47.1

2 files

1.47.0

2 files

1.46.1

2 files

1.46.0

2 files

1.45.0

2 files

1.44.0

2 files

1.43.0

2 files

1.42.0

2 files

1.41.0

2 files

1.40.0

2 files

1.39.1

2 files

1.39.0

2 files

1.38.0

2 files

1.37.0

2 files

1.36.0

2 files

1.35.0

2 files

1.34.1

2 files

1.34.0

2 files

1.33.0

2 files

1.32.0

2 files

1.31.0

2 files

1.30.0

2 files

1.29.0

2 files

1.28.1

2 files

1.28.0

2 files

1.27.0

2 files

1.26.0

2 files

1.25.0

2 files

1.24.1

2 files

1.24.0

2 files

1.23.0

2 files

1.22.0

2 files

1.21.1

2 files

1.21.0

2 files

1.20.3

2 files

1.20.2

2 files

1.20.1

2 files

1.20.0

2 files

1.19.0

2 files

1.18.0

2 files

1.17.1

2 files

1.17.0

2 files

1.16.0

2 files

1.15.8

2 files

1.15.7

2 files

1.15.6

2 files

1.15.5

2 files

1.15.4

2 files

1.15.3

2 files

1.15.2

2 files

1.15.1

2 files

1.15.0

2 files

1.14.0

2 files

1.13.0

2 files

1.12.3

2 files

1.12.2

2 files

1.12.1

2 files

1.12.0

2 files

1.11.3

2 files

1.11.2

2 files

1.11.1

2 files

1.11.0

2 files

1.10.0

2 files

1.9.0.post2

2 files

1.9.0.post1

2 files

1.9.0

2 files

1.8.1

2 files

1.8.0

2 files

1.7.0.post0

2 files

1.7.0

2 files

1.6.1

2 files

1.6.0

2 files

1.5.0

2 files

1.4.3

1 file

1.4.2

1 file

1.4.1

1 file

1.4.0

1 file

1.3.1

1 file

1.3.0.post2

1 file

1.3.0.post1

1 file

1.3.0

1 file

1.2.0

1 file

1.1.0

1 file

1.0.3

1 file

1.0.2

1 file

1.0.1

1 file

1.0.0

0.9.0

0.2.2

1 file

0.2.1

1 file

0.2.0

1 file

0.1.1

1 file

0.1.0

1 file

0.0.10

1 file

0.0.9.1

1 file

0.0.9

1 file

0.0.8.4

1 file

0.0.8.3

1 file

0.0.8.2

1 file

0.0.8.1

1 file

0.0.8

1 file

0.0.7

1 file

0.0.6

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page