Usage

Using gh-sync

Getting gh-sync

either install it globally

bun

bun add -g @cogniwave/gh-sync

yarn

yarn global add @cogniwave/gh-sync

pnpm

pnpm add -g @cogniwave/gh-sync

npm

npm i -g @cogniwave/gh-sync

1. just execute it directly

bun

bunx @cogniwave/gh-sync <origin> <destination> [options]

yarn

yarn dlx @cogniwave/gh-sync <origin> <destination> [options]

pnpm

pnpm dlx @cogniwave/gh-sync <origin> <destination> [options]

npm

npx @cogniwave/gh-sync <origin> <destination> [options]

Arguments

gh-sync has 2 arguments. They're both required and string

Name	Description
source	The repo to get the configurations from. Should be just the owner and repo itself, e.g.: {owner}/{repository}
destination	The repo to update. Should be just the owner and repo itself, e.g.: {owner}/{repository}

Example:

gh-sync myorg/arepo myuser/somerepo

Options

Name	Description
-V, --version	Prints the version number
-h, --help	display help for command
--verbose (default: false)	Runs gh-sync in verbose mode
--token	Auth token to allow gh-sync to do it's thing. Use this if the token is the same for both origin and destination repositories
--token-origin	Auth token of the origin repository, to allow gh-sync to do it's thing
--token-destination	Auth token of the destination repository,to allow gh-sync to do it's thing

You can read more about the options in Options