go-mygit

README

go-MyGit - Git action with group, implement in Go

go-mygit is a command line tools for easy configuration of git remote, github/gites repositories.

This is a replacement of mygit which was written in bash.

• Who & Why
• Features
• Limitation
• Usage
  • go-mygit
  • go-mygit config
  • go-mygit remote
  • go-mygit repository
  • Configuration File
  • Debug
  • Info
  • Selector
    • -g/--group
    • -r/--remote
  • Git Base Commands
    • init
    • push
      • --tags
      • --all
• Repository
• Contributors
• Change Log
• License

Who & Why

• Creating repositories for same set of remote servers repeatedly
• Setting up repositories on multiple machines repeatedly
• Working with repositories that push to same set of git servers

Features

• Info
  • debug
  • remote
  • group
• Selector
  • -g/--group
  • -r/--remote
• Git Base Commands
  • init
  • push
    • --all
    • --tag
• API(repo) Commands
  • repo/repository
    • delete
    • get
    • new
    • description
      • get
      • set
    • private
      • get
      • private
      • public
    • secret
      • set
    • topic
      • get
      • set
    • visibility
      • get
      • set

Limitation

• Current supported git servers
  • gitea
  • github
  • gogs
• API commands must be executed at root of repository

Usage

go-mygit

Usage:
  go-mygit [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  config      Print configuration
  help        Help about any command
  init        Git init and set remotes
  push        Push to all remotes
  remote      go-mygit remote commands
  repository  Repository commands

Flags:
      --config string        config file (default is $HOME/.go-mygit.json)
  -d, --debug                Enable debug
  -g, --group stringArray    Specify group
  -h, --help                 help for go-mygit
  -r, --remote stringArray   Specify remotes
  -t, --toggle               Help message for toggle

Use "go-mygit [command] --help" for more information about a command.

go-mygit config

Print configuration

Usage:
  go-mygit config [command]

Aliases:
  config, c, conf

Available Commands:
  all         Print all configuration
  group       Print groups in configuration
  remote      Print remotes configuration
  secret      Print secret in configuration

Flags:
  -h, --help   help for config

Global Flags:
      --config string        config file (default is $HOME/.go-mygit.json)
  -d, --debug                Enable debug
  -g, --group stringArray    Specify group
  -r, --remote stringArray   Specify remotes

Use "go-mygit config [command] --help" for more information about a command.

go-mygit remote

go-mygit remote commands

Usage:
  go-mygit remote [command]

Aliases:
  remote, rmt

Available Commands:
  add         Add git remotes base on configuration and flags
  get         List git remotes in current repository
  remove      Delete remotes in current repository

Flags:
  -h, --help   help for remote

Global Flags:
      --config string        config file (default is $HOME/.go-mygit.json)
  -d, --debug                Enable debug
  -g, --group stringArray    Specify group
  -r, --remote stringArray   Specify remotes

Use "go-mygit remote [command] --help" for more information about a command.

go-mygit repository

# go-mygit repository
Repository commands

Usage:
  go-mygit repository [command]

Aliases:
  repository, repo

Available Commands:
  delete      Delete remote repositoy
  description Remote repositories description command
  get         Get remote repositoy info
  list        List all repositories in remote.
  new         Create remote repositoy
  private     Repositories private commands
  secret      Remote repository secret commands.
  topic       Remote repository topics commands.
  visibility  Remote reposities visibility commands.

Flags:
  -h, --help   help for repository

Global Flags:
      --config string        config file (default is $HOME/.go-mygit.json)
  -d, --debug                Enable debug
  -g, --group stringArray    Specify group
  -r, --remote stringArray   Specify remotes

Use "go-mygit repository [command] --help" for more information about a command.

Configuration File

Following configuration will be used in all examples:

{
	"secrets": [
		{
			"name": "",
			"value": ""
		},
		{
			"name": "",
			"value": ""
		}
	],
	"remotes": [
		{
			"group": "",
			"name": "GitHub",
			"private": false,
			"ssh": "",
			"token": "",
			"entrypoint": "https://api.github.com",
			"vendor": "github"
		},
		{
			"group": "",
			"name": "MyServer",
			"private": true,
			"ssh": "",
			"token": "",
			"entrypoint": "https://gt.jsiu.dev/api/v1",
			"user": "",
			"vendor": "gitea"
		}
	]
}

Debug

Use -d for debug output.

Example:

go-mygit -d repo des get

Info

The remote and group command provide a quick way to see what is configured.

Selector

go-mygit allow command applied to groups or remotes through the use of -g/--group and -r/--remote. This applies to all commands except remote and group mentioned above.

-g/--group and -r/--remote must be placed right after mygit and before any command.

-g/--group

go-mygit -g external <command>
go-mygit -g external -g internal <command>

-r/--remote

go-mygit -r gh <command>
go-mygit -r gh -r server3 <command>

-g/--group and -r/--remote can be used at the same time.

go-mygit -g external -r server2 <command>

Git Base Commands

init, push are git base commands.

init

go-mygit init will clear all existing remote and add remote base on -g/-r selector. If no group nor remote are specified, all configured remotes will be added.

go-mygit init by default use current directory name as repository name. Repository name can be specified in the format go-mygit init <repository>. File .go-mygit.json containing the repository name will be created, which is used by API based commands.

Before go-mygit init:

$ git remote -v
origin  https://github.com/J-Siu/mygit.git (fetch)
origin  https://github.com/J-Siu/mygit.git (push)

go-mygit init without selector:

$ go-mygit init
Reinitialized existing Git repository in /tmp/mygit/.git/

$ git remote -v
gh      git@github.com:/username1/mygit.git (fetch)
gh      git@github.com:/username1/mygit.git (push)
server2 git@server2:/username2/mygit.git (fetch)
server2 git@server2:/username2/mygit.git (push)
server3 git@server3:/username3/mygit.git (fetch)
server3 git@server3:/username3/mygit.git (push)

go-mygit init with group internal:

$ go-mygit --group internal init
Reinitialized existing Git repository in /tmp/mygit/.git/

$ git remote -v
server2 git@server2:/username2/mygit.git (fetch)
server2 git@server2:/username2/mygit.git (push)
server3 git@server3:/username3/mygit.git (fetch)
server3 git@server3:/username3/mygit.git (push)

go-mygit init with repository name:

$ go-mygit init mygit2
Reinitialized existing Git repository in /tmp/mygit/.git/

$ git remote -v
gh      git@github.com:/username1/mygit2.git (fetch)
gh      git@github.com:/username1/mygit2.git (push)
server2 git@server2:/username2/mygit2.git (fetch)
server2 git@server2:/username2/mygit2.git (push)
server3 git@server3:/username3/mygit2.git (fetch)
server3 git@server3:/username3/mygit2.git (push)

push

go-mygit push will do git push and git push --tag base on -g/-r selector. If no group nor remote are specified, all configured remotes will be pushed in sequence.

go-mygit push

go-mygit -r gh push

go-mygit push support options --master and --all

--tags

If --tags is used, go-mygit push will push all tags.

go-mygit push --tags

--all

If --all is used, mygit push will push all branches(--all).

go-mygit -r gh push --all

Repository

• go-mygit

Contributors

• John, Sing Dao, Siu

Change Log

• v1.0.0
  • Feature complete
• v1.0.1
  • Fix repo new endpoint

License

The MIT License (MIT)

Copyright © 2022 John, Sing Dao, Siu john.sd.siu@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

Copyright © 2022 John, Sing Dao, Siu <john.sd.siu@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.