Skip to content

Latest commit

 

History

History
169 lines (92 loc) · 4.73 KB

README.ja.md

File metadata and controls

169 lines (92 loc) · 4.73 KB

gitb Build Status Coverage Status

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

概要

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

gitbコマンドはすべてのgitコマンドをラップしているので、 gitb fetchgitb pullgitb 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 <STATE>]

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

gitb pr show [<PR-ID>]

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

gitb pr add [-b <BASE>]

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

gitb pr blame [git blame command options] <PATH>

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

OPTIONS:

-s, --state <STATE>

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

-b, --base <BASE>

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

課題

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

COMMANDS:

gitb issue [-s <STATE>]

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

gitb issue show

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

gitb issue add

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

OPTIONS:

-s, --state <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 <hash>

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

エイリアス

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

Bash, Zsh

function git(){
  gitb "$@"
}

Fish

function git
  gitb $argv
end

謝辞

バグとフィードバック

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

ライセンス

MIT License

著者

vvatanabe