Polyrepo CLI 🚀

                 __
    ____  ____  / /_  __________  ____  ____
   / __ \/ __ \/ / / / / ___/ _ \/ __ \/ __ \
  / /_/ / /_/ / / /_/ / /  /  __/ /_/ / /_/ /
 / .___/\____/_/\__, /_/   \___/ .___/\____/
/_/            /____/         /_/

🤙 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.

📦 Installation

go install github.com/polyrepopro/polyrepo@latest

👉 Getting Started

polyrepo init

This 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 polyrepo download the config file from a URL? Just pass the -u flag with a URL to a config file!

Try it now: polyrepo init -u https://raw.githubusercontent.com/polyrepopro/cli/main/.polyrepo.yaml

This will download the config file from the URL and save it to the path you pass with -p or ~/.polyrepo.yaml if not specified.

Pulling Changes

Keep your local repositories in sync with the remote repositories by pulling the latest changes automagically with a single command:

polyrepo pull

This will pull the latest changes for all repositories in the workspace configured in the .polyrepo.yaml file.

Enabling Fast-Forward Merge 🎯

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-accept

Commiting & Pushing Changes

polyrepo commit --workspace dev --message "Test commit @ $(date)"
polyrepo push --workspace dev

You 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]

Commands

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.

`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.

This will overwrite the .polyrepo.yaml file 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.

`polyrepo run`

Run command(s) in each repository in the and watch for changes.

Use watch: true in 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"
                  - "."

`polyrepo status`

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 status

Example output:

`polyrepo sync`

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.

`polyrepo checkout`

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.

`polyrepo commit`

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.

`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.

⚙️ Configuration

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/cli

A more complex example:

deafult: 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"
                  - "."

Schema

Workspace

Field	Type	Description
name	string	The name of the workspace.
path	string	The path to the workspace.
repositories	[]Repository	The repositories containedin the workspace.

Repository

Field	Type	Description
url	string	The URL of the repository.
branch	string	The branch to sync the repository to.
path	string	The path to the repository in the workspace.
watches	[]Watch	The watches for the repository.

Watch

Field	Type	Description
cwd	string	The current working directory to watch.
paths	[]string	The paths to watch for changes.
commands	[]Command	The commands to run when changes are detected.

Command

The command is an array of strings that make up the command to run:

command:
  - "go"
  - "run"
  - "main.go"

Field	Type	Description
name	string	The name of the command.
command	[]string	The command to run.

Happy multi-repo hacking! ✨

Name		Name	Last commit message	Last commit date
Latest commit History 71 Commits
.vscode		.vscode
docs		docs
util		util
commit.go		commit.go
common.go		common.go
dockerfile		dockerfile
go.mod		go.mod
go.sum		go.sum
info.go		info.go
init.go		init.go
main.go		main.go
makefile		makefile
pull.go		pull.go
push.go		push.go
readme.md		readme.md
run.go		run.go
status.go		status.go
switch.go		switch.go
sync.go		sync.go

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Polyrepo CLI 🚀

📦 Installation

👉 Getting Started

Pulling Changes

Enabling Fast-Forward Merge 🎯

Commiting & Pushing Changes

Commands

`polyrepo help`

`polyrepo version`

`polyrepo init`

`polyrepo run`

`polyrepo status`

`polyrepo sync`

`polyrepo checkout`

`polyrepo commit`

`polyrepo commit-and-push`

`polyrepo push`

`polyrepo pull`

`polyrepo repo add`

`polyrepo repo remove`

`polyrepo repo sync`

`polyrepo repo track`

⚙️ Configuration

Schema

Workspace

Repository

Watch

Command

About

Releases

Contributors 2

Languages

polyrepopro/polyrepo

Folders and files

Latest commit

History

Repository files navigation

Polyrepo CLI 🚀

📦 Installation

👉 Getting Started

Pulling Changes

Enabling Fast-Forward Merge 🎯

Commiting & Pushing Changes

Commands

polyrepo help

polyrepo version

polyrepo init

polyrepo run

polyrepo status

polyrepo sync

polyrepo checkout

polyrepo commit

polyrepo commit-and-push

polyrepo push

polyrepo pull

polyrepo repo add

polyrepo repo remove

polyrepo repo sync

polyrepo repo track

⚙️ Configuration

Schema

Workspace

Repository

Watch

Command

About

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors 2

Languages

`polyrepo help`

`polyrepo version`

`polyrepo init`

`polyrepo run`

`polyrepo status`

`polyrepo sync`

`polyrepo checkout`

`polyrepo commit`

`polyrepo commit-and-push`

`polyrepo push`

`polyrepo pull`

`polyrepo repo add`

`polyrepo repo remove`

`polyrepo repo sync`

`polyrepo repo track`