tsrc: manage groups of git repositories

Overview · Installation · Usage example · Documentation · Release notes · Contributing · License

Note

This project was originally hosted on the TankerHQ organization, which was my employer from 2016 to 2021. They kindly agreed to give back ownership of this project to me. Thanks!

Overview

tsrc is a command-line tool that helps you manage groups of several git repositories.

It can be seen in action on asciinema.org.

Note

tsrc does not adhere strictly to the semver specification. So before upgrading to a new version, please take the time to read the Changelog first!

Installation

The recommended way to install tsrc is to use pipx

• Make sure to have Python 3.7 or later installed.
• Install pipx
• Run pipx install tsrc.

Usage Example

• Create a manifest repository. ([email protected]/manifest.git)
• Add a file named manifest.yml at the root of the manifest repository.

manifest.yml:

repos:
  - url: [email protected]/foo.git
    dest: foo

 -  url: [email protected]/bar.git
    dest: bar

It is convenient while optional to include the manifest repository itself in your manifest.yml. It will allow you to have a local copy of you manifest repository to easily make changes to it in the future.

• commit your manifest.yml and push the changes to the manifest repository.
• Create a new workspace with all the repositories listed in the manifest:

$ tsrc init [email protected]/manifest.git

:: Configuring workspace in /path/to/work
...
=> Cloning missing repos
* (1/2) foo
...
* (2/2) bar
...
: Configuring remotes
Done ✓

• Synchronize all the repositories in the workspace:

$ tsrc sync
=> Updating manifest
...
:: Configuring remotes
:: Synchronizing workspace
* (1/2) foo
=> Fetching origin
=> Updating branch
Already up to date
* (2/2) bar
=> Updating branch
Updating 29ac0e1..b635a43
Fast-forward
 bar.txt | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 bar.txt
Done ✓

Documentation

For more details and examples, please refer to tsrc documentation.

Release notes

Detailed changes for each release are documented in the changelog.

Contributing

We welcome feedback, bug reports, and bug fixes in the form of pull requests.

Detailed instructions can be found in the documentation.

License

tsrc is licensed under a BSD 3-Clause license.