Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyoh86/gogh
GO GitHub project manager
https://github.com/kyoh86/gogh
cli-app ghq github go golang golang-tools
Last synced: about 2 months ago
JSON representation
GO GitHub project manager
- Host: GitHub
- URL: https://github.com/kyoh86/gogh
- Owner: kyoh86
- License: mit
- Created: 2015-12-16T11:09:27.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T01:25:08.000Z (9 months ago)
- Last Synced: 2024-04-02T12:23:22.288Z (9 months ago)
- Topics: cli-app, ghq, github, go, golang, golang-tools
- Language: Go
- Homepage:
- Size: 8.84 MB
- Stars: 29
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gogh
GO GitHub project manager
[](https://pkg.go.dev/kyoh86/gogh)
[](https://goreportcard.com/report/github.com/kyoh86/gogh)
[](https://codecov.io/gh/kyoh86/gogh)
[](https://github.com/kyoh86/gogh/releases)
## Description
**`gogh` is forked from [`ghq`](https://github.com/motemen/ghq).**
```console
$ gogh list
github.com/kyoh86/git-branches
github.com/kyoh86/gogh
github.com/kyoh86/vim-wipeout
github.com/kyoh86-tryouts/bare
github.com/nvim-telescope/telescope.nvim
...
```
`gogh` provides a way to organize remote repository clones, like `go get` does. When you clone a
remote repository by `gogh get`, `gogh` makes a directory under a specific root directory (by default
`~/go/src`) using the remote repository URL's host and path. And creating new one by `gogh new`,
`gogh` make both of a local project and a remote repository.
```console
$ gogh get https://github.com/kyoh86/gogh
# Runs `git clone https://github.com/kyoh86/gogh ~/go/src/github.com/kyoh86/gogh`
```
You can also list projects (local repositories) (`gogh list`).
## Install
### For Golang developers
```console
$ go install github.com/kyoh86/gogh/cmd/gogh@latest
```
If you want zsh-completions, you can create completions file like this:
```console
$ echo "autoload -Uz compinit && compinit" >> ~/.zshrc
$ gogh completion zsh > $fpath[1]/_gogh
```
### `Homebrew`/`Linuxbrew`
```console
$ brew tap kyoh86/tap
$ brew update
$ brew install kyoh86/tap/gogh
```
### `Makepkg`
```console
$ mkdir -p gogh_build && \
cd gogh_build && \
curl -L --silent https://github.com/kyoh86/gogh/releases/latest/download/gogh_PKGBUILD.tar.gz | tar -xvz
$ makepkg -i
```
## Setup
`gogh` manages repositories in multiple servers that is pairs of an owner and a host name.
To login in new server or logout, you should use `auth login` with personal access tokens.
You should generate personal access tokens with "Repository permissions":
- ✅ Read-only access to "Contents" and "Metadata"
- ✅ Read and write access to "Administration"
## Available commands
See manual for detail: [usage/gogh.md](./usage/gogh.md).
### Show projects
| Command | Description |
| -- | -- |
| `gogh list` | List local projects |
| `gogh repos` | List remote repositories |
### Manipulate projects
| Command | Description |
| -- | -- |
| `gogh create` | Create a new project with a remote repository |
| `gogh delete` | Delete a repository with a remote repository |
| `gogh fork` | Fork a repository |
| `gogh clone` | Clone a repository to local |
### Others
| Command | Description |
| -- | -- |
| `gogh roots` | Manage roots |
| `gogh auth` | Manage Authentications |
| `gogh bundle` | Manage bundle |
| `gogh help` | Help about any command |
Use `gogh [command] --help` for more information about a command.
Or see the manual in [usage/gogh.md](./usage/gogh.md).
## Configurations
### Roots
`gogh` manages projects under the `roots` directories.
See also: [Directory structures](#Directory+structures)
You can change the roots with `roots add ` or `roots remove ` and see all of them by
`roots list`. `gogh` uses the first one as the default one, `create`, `fork` or `clone` will put a
local project under it. If you want to change the default, use `roots set-default `.
Default: `~/Projects`.
### Default Host and Owner
When you specify a repository with ambiguous user or host, it will be interpolated with a default
value. You may set them with `set-default`.
If you set them like below:
| key | value |
| - | - |
| `host` | `example.com` |
| `owner` | `kyoh86` |
ambiguous repository names will be interpolated:
| Ambiguous name | Interpolated name |
| -- | -- |
| `gogh` | example.com/kyoh86/gogh |
| `foobar/gogh` | example.com/foobar/gogh |
NOTE: default host will be "github.com" if you don't set it.
## Directory structures
Local projects are placed under `gogh.roots` with named `*host*/*user*/*repo*.
```
~/Projects
+-- github.com/
|-- google/
| +-- go-github/
|-- kyoh86/
| +-- gogh/
+-- alecthomas/
+-- kingpin/
```
# LICENSE
[](http://www.opensource.org/licenses/MIT)
This software is released under the [MIT License](http://www.opensource.org/licenses/MIT), see
LICENSE. And this software is based on [`ghq`](https://github.com/motemen/ghq).