Get all the projects with pully! 🪀
Project description
pully 🪀
pully is a tool for managing a large number of Git repository checkouts
effectively.
Why pully
pully was created to make managing and automating changes to multiple projects
easier. There are two general use cases pully is designed to address. First, a
mass action where a a set of projects is cloned and the same action is run on
each project. Second, managing a local workspace for a set of projects.
Large scale changes
pully helps solve problems where you need to make the same
action across multiple projects.
- Update the copyright date in the license file of all projects.
- Update pre-commit versions in all projects.
- Add
badgieto all projects.
The recommended workflow in this case is to use pully to clone workspaces for
mass actions not regular development. Avoid using the same project workspaces
for both regular development and automated actions. Different branches, new
files, and unknown state that are common in work in progress are likely to
interfere with scripted changes.
Manage local workspaces
pully can be used to manage project checkouts for regular development. This
makes onboarding new developers or setting up new environments easier. Common
tasks like pulling the latest changes or pruning remote branches are easy to do.
Beware of scripting changes to multiple projects since the status of each
project may different and cause unexpected results.
With great power comes great responsibility
We recommend tremendous caution when automating repository changes. Some tips:
- Avoid making and committing changes in a single command.
- Ensure that a human is reviewing all changes before committing.
- Automate the creation of branches and merge requests as a minimally privileged user.
We expect some of these workflows to become pully features in the future.
Installation
python3 -m pip install pully
Quickstart
# add projects for pully to track
pully add -G saferatday0/library
# clone/fetch all projects
pully get
# run commands in checked out projects
pully run touch .gitkeep
Usage
Initialize a project workspace
Run pully init to create a project workspace.
pully init
A .pully.json will be created in the current directory that will be used to
track project checkouts.
Add projects for tracking
Track any project by path:
pully add -P saferatday0/badgie
$ pully add -P saferatday0/badgie
searching for group id by full path saferatday0
searching for project id by full path
found project ids: [70752539]
found pully file at /home/user/projects/.pully.json
adding saferatday0/badgie
Track any group by path (subgroups are supported):
pully add -G saferatday0/library
$ pully add -G saferatday0/library
searching for group id by full path saferatday0/library
found group ids: [108399662]
creating new pullyfile at /home/user/projects
adding saferatday0/library/ansible
adding saferatday0/library/asciidoctor
...
adding saferatday0/library/verible
adding saferatday0/library/zola
Only newly added projects will be printed.
Clone/fetch all repositories
Call pully get to clone tracked projects to your local filesystem:
pully get
$ pully get
found pully file at /home/user/projects/.pully.json
cloning saferatday0/library/ansible (70326944)
cloning saferatday0/library/asciidoctor (70588591)
...
cloning saferatday0/library/zola (70432884)
cloning saferatday0/badgie (70752539)
The download strategy can be selected with -s/--strategy. Multiple
strategies are available:
-
clone (default) - Clone the repository, skipping if it is already present.
-
fetch - Clone the repository if not found, or fetch updates if found.
-
pull - Clone the repository if not found, or fetch and merge updates if found.
The clone, fetch, or pull depth can be set with --depth. This is particularly
useful when you want to run the same command on many projects and only need the
latest commit.
List all checked out projects
pully ls
$ pully ls
found pully file at /home/user/projects/.pully.json
cloned 70326944 saferatday0/library/ansible
cloned 70588591 saferatday0/library/asciidoctor
- 70588591 saferatday0/library/container
...
Filter by project path
The ls, pull, and run commands support filtering by local path prefix
using the -p/--path-prefix option:
$ pully get -p saferatday0/badgie
found pully file at /home/bweir/Projects/gitlab.com/.pully.json
fetching saferatday0/badgie (70752539)
fetching saferatday0/badgie.me (45125259)
Running commands on repositories
The pully run command can be used to run a command in each repository.
Commands can be run in one of two ways:
-
As arguments
-
Using
-c/--command
As arguments
When run this way, commands are run directly, a shell is not instantiated, and executable paths are fully resolved:
pully run git status
Command line options can be passed using --:
pully run -- ls -l
Using -c/--command
When run this way, a shell is launched, so shell features like indirection and pipes can be used
pully run -c 'echo "$(pwd) $(git branch)"'
["/bin/sh", "-euc"] is the default entrypoint. A different entrypoint can be
specified with -e/--entrypoint:
pully run -e '["python3", "-c"]' -c 'fp = open(".gitignore", "a"); fp.write("*.pdf\n");'
$ pully run -e '["python3", "-c"]' -c 'fp = open(".gitignore", "a"); fp.write("*.pdf\n");'
found pully file at /home/user/projects/.pully.json
running saferatday0/library/ansible --------------------------------------------
running saferatday0/library/asciidoctor ----------------------------------------
...
$ cd saferatday0/badgie/
$ git diff
diff --git a/.gitignore b/.gitignore
index c84b6c9..e56720a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,4 @@ build/
env.sh
node_modules/
+*.pdf
Project environment variables
pully run populates a few environment variables with information about the
current context.
PULLY_PROJECT_PATH
The path to the cloned project repository relative to the pully file directory.
$ echo $PULLY_PROJECT_PATH
saferatday0/handbook
PULLY_PROJECT_FULL_PATH
The full path to the cloned project repository.
$ echo $PULLY_PROJECT_FULL_PATH
/home/user/Projects/saferatday0/handbook
Cleanup
Reverting changes is easy:
pully run git checkout .
$ pully run git checkout .
found pully file at /home/bweir/blah/.pully.json
running saferatday0/library/ansible --------------------------------------------
Updated 1 path from the index
running saferatday0/library/asciidoctor ----------------------------------------
Updated 1 path from the index
Private repositories
pully can clone private repositories by setting the GITLAB_PRIVATE_TOKEN
environment variable.
Note: This classic token requires at least the read_repository permission to pull, and the write_repository permission to write.
export GITLAB_PRIVATE_TOKEN="XXXXXX"
pully add -G private/namespace
pully get
Certain organizations may require SSH authentication to pull repositories. If you recieve git pull-related error messages, ensure an ssh-agent is running, and your SSH identity is added to it:
pgrep ssh-agent # Check if an ssh-agent is running
eval "$(ssh-agent -s)" # If not, start one
ssh-add ~/.ssh/id_rsa # Point to your SSH private key
License
Copyright 2025 UL Research Institutes.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pully-0.13.0.tar.gz.
File metadata
- Download URL: pully-0.13.0.tar.gz
- Upload date:
- Size: 19.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
04db263498167f674bdc29263f055675a60e34638718e63e3f68da11cee11efb
|
|
| MD5 |
eb2877582b5e4ab46e2f9033fb0942b1
|
|
| BLAKE2b-256 |
a7fd347df42e89b411b1b2da3cc1e02133de5b7d7a6e3af783479f63ee619657
|
File details
Details for the file pully-0.13.0-py3-none-any.whl.
File metadata
- Download URL: pully-0.13.0-py3-none-any.whl
- Upload date:
- Size: 19.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
094c13fa8492c8e085a32628cc644271ac3ee8053341a049d0920de504056127
|
|
| MD5 |
bce020dcd6cb52aabc70cc26162e75ed
|
|
| BLAKE2b-256 |
e00cf2481c1ee52be47fad517b2fd7466427d03c3f4fb5bd19b62b7092cef7ee
|