__
____ ____ / /_ __________ ____ ____
/ __ \/ __ \/ / / / / ___/ _ \/ __ \/ __ \
/ /_/ / /_/ / / /_/ / / / __/ /_/ / /_/ /
/ .___/\____/_/\__, /_/ \___/ .___/\____/
/_/ /____/ /_/🤙 Simplify. Streamline. https://polyrepo.pro
The way we organize our codebases can significantly impact our productivity, collaboration, and overall happiness.
Polyrepo is a tool for managing polyrepo workspaces like a boss.
Keep your local and remote repositories in sync, commit and push changes to multiple repositories with a single command, share a single config file with your team, and more.
go install github.com/polyrepopro/polyrepo@latestpolyrepo initThis will create a .polyrepo.yaml file in your home directory with a default configuration (if you do not pass a path with -p).
You can then add your repositories and workspaces to the configuration file.
Did you know you can have
polyrepodownload the config file from a URL? Just pass the-uflag with a URL to a config file!Try it now:
polyrepo init -u https://raw.githubusercontent.com/polyrepopro/cli/main/.polyrepo.yamlThis will download the config file from the URL and save it to the path you pass with
-por~/.polyrepo.yamlif not specified.
Keep your local repositories in sync with the remote repositories by pulling the latest changes automagically with a single command:
polyrepo pullThis will pull the latest changes for all repositories in the workspace configured in the .polyrepo.yaml file.
Sometimes when you pull changes into a repository you want the changes to automatically be merged in.
This will prompt you to merge the changes in most cases which will require you to resolve conflicts
manually outside of polyrepo.
polyrepo allows you to enable fast-forward merges by adding the following to your .gitconfig:
[pull]
rebase = false
ff = true # automatic merging on pull
[merge]
ff = true # allow fast-forward merges to auto-acceptpolyrepo commit --workspace dev --message "Test commit @ $(date)"
polyrepo push --workspace devYou can also specify a config file and/or name to be explicit:
polyrepo --config ~/workspace/nvr.ai/.polyrepo.yaml commit --workspace dev --message "Test commit @ $(date)"
2024/09/02 11:39:29 [INFO] workspace.commit: committed map[messages:[{} {}] path:~/workspace/nvr.ai repositories:2 workspace:dev]
polyrepo --config ~/workspace/nvr.ai/.polyrepo.yaml push --workspace dev
2024/09/02 11:40:40 [INFO] workspace.push: pushed changes for all repositories map[path:~/workspace/nvr.ai repositories:2 workspace:dev]| Command | Description |
|---|---|
polyrepo help |
Show the help for the polyrepo CLI. |
polyrepo version |
Show the version of the polyrepo CLI. |
polyrepo init |
Initialize a new global .polyrepo.yaml configuration file. |
polyrepo run |
Run a command(s) in each repository and watch for changes. |
polyrepo status |
Show the status of the polyrepo workspace. |
polyrepo sync |
Sync with the remotes. |
polyrepo switch |
Switch the branch of repositories in a workspace. |
polyrepo commit |
Commit the changes for each repository in the workspace. |
polyrepo commit-and-push |
Commit the changes for each repository in the and push. |
polyrepo push |
Push the changes for each repository in the workspace. |
polyrepo pull |
Pull the latest changes for each repository in the workspace. |
polyrepo repo add |
Add a repository to the polyrepo workspace. |
polyrepo repo remove |
Remove a repository from the polyrepo workspace. |
polyrepo repo sync |
Sync a repo with the remote. |
polyrepo repo track |
Adds the current working directory to the polyrepo workspace. |
Show the help for the polyrepo CLI.
Show the version of the polyrepo CLI.
Initialize a new global .polyrepo.yaml configuration file.
This will overwrite the
.polyrepo.yamlfile at the given path if it exists.
| Flag | Default | Required | Description |
|---|---|---|---|
| -p, --path | ~/.polyrepo.yaml |
Yes | The path to save the .polyrepo.yaml file. |
| -u, --url | No | A URL to download the .polyrepo.yaml file from. |
Run command(s) in each repository in the and watch for changes.
Use
watch: truein the runner to watch for changes and automatically restart the command(s) base on pattern matchers.
Example configuration with watches:
workspaces:
- name: example
path: ~/workspace/polyrepo-example
repositories:
- url: git@github.com:polyrepopro/example-test-repo.git
branch: main
path: examples/example-test-repo
runners:
- watch: true
matchers:
- include: "go.mod"
- include: ".go$"
ignore: "pkg/go-glib"
commands:
- name: "run"
command:
- "go"
- "run"
- "."Show the status of all polyrepo workspace repositories.
| Flag | Default | Required | Description |
|---|---|---|---|
| -w, --workspace | Optional | The name of the to show the status of or all. | |
| -t, --tags | Optional | The tags to filter the repositories by. |
go statusExample output:
Sync with the remotes.
This command syncs the by ensuring that each repository exists locally.
| Flag | Default | Required | Description |
|---|---|---|---|
| -w, --workspace | Yes | The name of the to sync. |
Switch the default workspace.
![NOTE] This will modify the
.polyrepo.yamlfile by setting thedefaultworkspace value.
| Flag | Default | Required | Description |
|---|---|---|---|
| -w, --workspace | Yes | The name of the to switch branch on. | |
| -b, --branch | Yes | The branch to switch the repositories to. |
Checkout a branch across all repositories in a workspace.
| Flag | Default | Required | Description |
|---|---|---|---|
| -w, --workspace | The name of the to checkout branch on. | ||
| -b, --branch | Yes | The branch to checkout the repositories to. |
Commit the changes for each repository in the workspace.
| Flag | Default | Required | Description |
|---|---|---|---|
| -w, --workspace | Yes | The name of the to commit for. | |
| -m, --message | Yes | The message to commit the repositories with. |
Commit the changes for each repository in the and push.
Push the changes for each repository in the workspace.
Pull the latest changes for each repository in the workspace.
Add a repository to the polyrepo workspace.
Remove a repository from the polyrepo workspace.
Sync a repo with the remote.
Adds the current working directory to the polyrepo workspace.
Polyrepo workspaces are configured in a .polyrepo.yaml file which can be created by running polyrepo init.
A simple example .polyrepo.yaml file looks like this:
workspaces:
- name: dev
path: ~/workspace/polyrepo-dev
repositories:
- url: git@github.com:polyrepopro/api.git
branch: main
path: pkg/api
- url: git@github.com:polyrepopro/cli.git
branch: main
path: pkg/cliA more complex example:
default: dev
workspaces:
- name: dev
path: ~/workspace/nvr.ai
repositories:
- name: mail
url: git@github.com:nvr-ai/go-mail.git
branch: main
path: pkg/mail
- name: config
url: git@github.com:nvr-ai/go-config.git
branch: main
path: pkg/config
- name: exceptions
url: git@github.com:nvr-ai/go-exceptions.git
branch: main
path: pkg/exceptions
- name: types
url: git@github.com:nvr-ai/go-types.git
branch: main
path: pkg/types
- name: spa
url: git@github.com:nvr-ai/apps/spa.git
branch: main
path: apps/spa
runners:
- cwd: apps/spa
matchers:
- path: src
include: ".svelte$|.ts$|.scss$|.pcss$|.json$"
ignore: "node_modules"
commands:
- name: "run"
command:
- "npm"
- "run"
- "dev"
- name: broker
url: git@github.com:nvr-ai/go-broker.git
branch: main
path: pkg/broker
runners:
- cwd: pkg/broker
watch: true
matchers:
- include: "go.mod"
- include: ".go$"
commands:
- name: "run"
command:
- "go"
- "run"
- "."
- name: ingester
url: git@github.com:nvr-ai/go-ingester.git
branch: main
path: pkg/ingester
runners:
- cwd: pkg/ingester
watch: true
matchers:
- include: "go.mod"
- include: ".go$"
commands:
- name: "run"
command:
- "go"
- "run"
- "."
- name: kubernetes-controller
url: git@github.com:nvr-ai/go-kubernetes-controller.git
branch: main
path: pkg/kubernetes-controller
runners:
- cwd: pkg/kubernetes-controller
watch: true
matchers:
- include: "go.mod"
- include: ".go$"
commands:
- name: "run"
command:
- "go"
- "run"
- "."
- name: streamer
url: git@github.com:nvr-ai/go-streamer.git
branch: main
path: pkg/go-streamer
runners:
- cwd: pkg/go-streamer
watch: true
matchers:
- include: "go.mod"
- include: ".go$"
ignore: "pkg/go-glib"
commands:
- name: "run"
command:
- "go"
- "run"
- "."
- name: webrtc
url: git@github.com:nvr-ai/go-webrtc.git
branch: main
path: pkg/webrtc
runners:
- cwd: pkg/webrtc
watch: true
matchers:
- include: "go.mod"
- include: ".go$"
commands:
- name: "run"
command:
- "go"
- "run"
- "."
optionalThis is an optional setting. If it is not set, the default workspace will be the first workspace in the list.
The default workspace name to use.
List of workspaces to use.
requiredThis is a required setting for each repository.
Path to the workspace (can be relative or absolute).
If a relative path is provided, it will be resolved relative to the workspaces[].path value.
Given the following configuration:
default: dev
workspaces:
- name: dev
path: ~/workspace/awesome-project
repositories:
- name: api
url: git@github.com:awesome-project/api.git
branch: main
path: pkg/apiThe resulting path for the repository will be ~/workspace/awesome-project/pkg/api.
The name of the repository.
The URL of the repository.
Branch name to sync the repository with.
Origin to sync the repository with (overrides default).
Path to the repository locally.
The current working directory to watch.
Whether to watch for changes.
List of matchers for the runner.
The pattern to include.
The pattern to ignore.
List of commands to run when changes are detected.
The name of the command.
The arguments to execute on the shell with.
The command is an array of strings that make up the command to run:
command:
- "go"
- "run"
- "main.go"The arguments to execute on the shell with.
The command is an array of strings that make up the command to run:
command:
- "go"
- "run"
- "main.go"Happy multi-repo hacking! ✨
