Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vvatanabe/gitb

A command line tool for using Backlog's git comfortably.
https://github.com/vvatanabe/gitb

backlog cli git golang

Last synced: 9 days ago
JSON representation

A command line tool for using Backlog's git comfortably.

Awesome Lists containing this project

README

        

# gitb [![Build Status](https://travis-ci.org/vvatanabe/gitb.svg?branch=master)](https://travis-ci.org/vvatanabe/gitb) [![Coverage Status](https://coveralls.io/repos/github/vvatanabe/gitb/badge.svg?branch=master)](https://coveralls.io/github/vvatanabe/gitb?branch=master)

Backlogのgitを快適に使うためのコマンドラインツール。

## 概要

`gitb`コマンドはBacklogのgitを快適に使うのに役立ちます。たとえば、PR、issue、branch、tagsなどをブラウザで1回のアクションで開くことができます。

`gitb`コマンドはすべての`git`コマンドをラップしているので、 `gitb fetch`、`gitb pull`、 `gitb push`のように` gitb`コマンドを使って`git-command`を実行することができます。

接尾辞Bには複数の意味があります。Backlog、Browser、Bダッシュ。

## インストール

### Homebrew

MacOSで使用可能なパッケージマネージャであるHomebrewでインストールできます。

```
$ brew tap vvatanabe/gitb
$ brew install gitb
```

### Go

Go言語(go1.13+)をインストールしていれば、go getコマンドでもインストールできます。

```
$ go get github.com/vvatanabe/gitb
```

### GitHub Release Page

ビルドされたバイナリはGithubのリリースで利用可能です:
https://github.com/vvatanabe/gitb/releases

## 使い方

### プルリクエスト

現在のリポジトリに対するBacklogのプルリクエストに関連するコマンドです。

__COMMANDS:__

`gitb pr [-s ]`

 現在のリポジトリのプルリクエスト一覧ページを開きます。

`gitb pr show []`

 指定した``のプルリクエストのページを開きます。``を指定しない時は、現在のブランチに関連したプルリクエストのページを開きます。

`gitb pr add [-b ]`

 現在のブランチでプルリクエストを追加するページを開きます。

`gitb pr blame [git blame command options] `

 指定した``の変更に関連するプルリクエストIDを行単位で表示します。`git blame`コマンドのオプションを適用できます。

__OPTIONS:__

`-s, --state `

 STATEでプルリクエストをフィルタリングします。値: "open" (初期値), "closed", "merged", "all".

`-b, --base `

 BASEはプルリクエストのベースとなるブランチ名です。デフォルトは空です。

### 課題

現在のリポジトリに対するBacklogの課題に関連するコマンドです。

__COMMANDS:__

`gitb issue [-s ]`

 現在のプロジェクトの課題一覧ページを開きます。

`gitb issue show`

 現在のブランチに関連する課題ページを開きます。

`gitb issue add`

 現在のプロジェクトに課題を追加するページを開きます。

__OPTIONS:__

`-s, --state `

 STATEで課題をフィルタリングします。 値: "all", "open", "in_progress", "resolved", "closed", "not_closed" (初期値).

### Browse

現在のリポジトリに関するGitページ(ブランチ、ツリー、タグ等)を開きます。

__COMMANDS:__

`gitb browse branch`

 現在のリポジトリのブランチ一覧ページを開きます。

`gitb browse tag`

 現在のリポジトリのタグ一覧ページを開きます。

`gitb browse tree`

 現在のブランチのツリーページを開きます。

`gitb browse history`

 現在のブランチの履歴ページを開きます。

`gitb browse network`

 現在のブランチのネットワークページを開きます。

`gitb browse repo`

 現在のプロジェクトのリポジトリ一覧ページを開きます。

`gitb browse show`

 与えられたファイルまたはディレクトリの該当するページを開きます。

`gitb browse commit `

 与えられたハッシュのコミットページを開きます。

## エイリアス

`gitb `を`git `として使いたい場合は、.XXXrc(.bashrc、.zshrc、config.fish)に以下のエイリアスを書いてください。

### Bash, Zsh

```
function git(){
gitb "$@"
}
```

### Fish

```
function git
gitb $argv
end
```

## 謝辞

- Inspired by [github.com/github/hub](https://github.com/github/hub)
- `gitb pr blame` is a Golang port of [kazuho/git-blame-pr.pl](https://gist.github.com/kazuho/eab551e5527cb465847d6b0796d64a39)

## バグとフィードバック

バグ、質問、ディスカッションについてはGithub Issuesを利用してください。

## ライセンス

[MIT License](http://www.opensource.org/licenses/mit-license.php)

## 著者

[vvatanabe](https://github.com/vvatanabe)