Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uetchy/gst
👻 Supercharge your ghq workflow.
https://github.com/uetchy/gst
cli-app ghq git
Last synced: 20 days ago
JSON representation
👻 Supercharge your ghq workflow.
- Host: GitHub
- URL: https://github.com/uetchy/gst
- Owner: uetchy
- License: other
- Created: 2015-06-27T08:01:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T11:20:58.000Z (over 1 year ago)
- Last Synced: 2024-10-07T16:43:01.489Z (about 1 month ago)
- Topics: cli-app, ghq, git
- Language: Go
- Homepage:
- Size: 479 KB
- Stars: 45
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
gst 👻
[](https://github.com/uetchy/gst/actions?query=goreleaser)
[](https://sake.sh/uetchy)
**gst** is a simple toolbox that offers additional commands (`list`, `new`, `rm`, `doctor`, `update`, `fetch`) for [ghq](https://github.com/x-motemen/ghq).
See [Quick Install](https://github.com/uetchy/gst#quick-install) for the installation guide.
## Usage
### `gst list` or `gst`
List **uncommitted changes** and **unpushed commits** within all repositories.
```bash
$ gst
/Users/uetchy/Repos/src/github.com/uetchy/gst (11 minutes ago)
uncommitted changes
M .travis.yml
M README.md
/Users/uetchy/Repos/src/github.com/uetchy/qiita-takeout (9 hours ago)
unpushed commits
409849d returns Promise.reject
```
with `--short` or `-s` option:
```bash
$ gst --short
/Users/uetchy/Repos/src/github.com/uetchy/ferret
/Users/uetchy/Repos/src/github.com/uetchy/gst
```
### new
Create a new git repository.
Before start using `new` and `rm` command, You **must** set `github.user` in gitconfig to your GitHub username: `git config --global github.user `.
```bash
$ gst new epic-project
/Users/uetchy/Repos/src/github.com/uetchy/epic-project
$ gst new epic-team/epic-project
/Users/uetchy/Repos/src/github.com/epic-team/epic-project
```
With `cd`, you can jump to the created project quickly:
```bash
cd $(gst new epic-project)
```
It's also good for having a handy alias for this workflow:
```bash
newrepo() {
cd $(gst new ${1})
}
```
### rm
Remove a git repository. It also removes the containing directory if the deleted repository was the sole repository the parent directory had.
```bash
$ gst rm retired-project
Remove? /Users/uetchy/Repos/src/github.com/uetchy/retired-project [Y/n]
Removed /Users/uetchy/Repos/src/github.com/uetchy/retired-project
Removed /Users/uetchy/Repos/src/github.com/uetchy
```
### doctor
Health-check over all repositories.
```bash
$ gst doctor
[bitbucket.org/uetchy/scent] git remote origin has changed:
Expected: github.com/uetchy/google-cloud-vision-raspi-sample
Actual: bitbucket.org/uetchy/scent
```
### update
`git pull` to all repositories.
```bash
$ gst update
/Users/uetchy/Repos/src/github.com/uetchy/gst
Already up-to-date.
```
### fetch
`git fetch --tags --prune` to all repositories.
```bash
$ gst fetch
/Users/uetchy/Repos/src/github.com/uetchy/gst
* [new branch] dev -> origin/dev
- [deleted] (none) -> origin/test
* [new tag] v1.0.0 -> v1.0.0
```
## Quick Install
See [releases](https://github.com/uetchy/gst/releases/latest).
macOS:
```bash
brew tap sake.sh/uetchy https://sake.sh/uetchy
brew install gst
```
Linux:
```bash
curl -L https://github.com/uetchy/gst/releases/download/v5.0.5/gst_linux_amd64 > /usr/local/bin/gst
chmod +x /usr/local/bin/gst
```
### Run as Docker container
You can take a glance at what `gst` do before installing the actual binary by running the containerized Docker image.
```bash
alias gst="docker run --rm -v \$(ghq root):/ghq -it uetchy/gst"
gst --help
gst list
```
### Pre-release build
macOS:
```bash
curl -L https://github.com/uetchy/gst/releases/download/pre-release/gst_darwin_amd64 > /usr/local/bin/gst
chmod +x /usr/local/bin/gst
```
Linux:
```bash
curl -L https://github.com/uetchy/gst/releases/download/pre-release/gst_linux_amd64 > /usr/local/bin/gst
chmod +x /usr/local/bin/gst
```
### Head build
```bash
go get github.com/uetchy/gst
```
## Development
PRs are welcome.
```bash
go build
./gst
```
### Test
Docker is required to run tests.
```bash
make test
```
## Contributors
