GitHub CLIを使ってみる
GitHub CLIとは？
GitHub CLIとは、その名の通り、コマンドライン上でGitHubの操作を行えるCLIツールです。
新規でリポジトリを作成したい場合やPRを確認したい場合などに、ブラウザを開かなくても操作できるので非常に便利です。
インストール
Macの場合はbrewでインストール。
$ brew install gh
認証
CLIコマンドを利用するためにはGitHubアカウントでログインする必要があります。
GitHub.comを選択。
? What account do you want to log into? [Use arrows to move, type to filter]
> GitHub.com
GitHub Enterprise Server
ブラウザでログインを選択。
? How would you like to authenticate? [Use arrows to move, type to filter]
> Login with a web browser
Paste an authentication token
すると、ワンタイムコードが表示されるのでコピーし、ブラウザに表示されている入力画面にコードを入力。
! First copy your one-time code: 6154-C343
- Press Enter to open github.com in your browser...
デフォルトプロトコルにSSHを選択。
? Choose default git protocol [Use arrows to move, type to filter]
HTTPS
> SSH
これでログイン完了！
✓ Logged in as Kazuhiro-Mimaki
リポジトリの操作
リポジトリ関連の操作が行えます。
試しに gh_sample という名前でリポジトリを作成してみます。
$ gh repo create gh_sample
コマンドを実行すると対話形式で進んでいきます。
今回は private で。
? Visibility [Use arrows to move, type to filter]
Public
> Private
Internal
Yes を選択してリポジトリを作成。
? This will create 'gh_sample' in your current directory. Continue? (Y/n)
ローカル環境にもディレクトリを作成するか聞かれるので、作成する場合は Yes。
これでリポジトリの作成は完了。
? Create a local project directory for Kazuhiro-Mimaki/gh_sample? (Y/n)
こんな感じで、後ろにオプションを付けてコマンドを実行することも可能です。
$ gh repo create gh_sample --private
リポジトリの操作は create 以外にも、 clone、fork、view が使えるみたいです。
PRの操作
プルリクエスト関連の操作が行えます。
こちらも試しにPRを作成してみましょう。
$ gh pr create
コマンドを実行すると、対話形式でタイトルや内容の入力を求められます。
ただ、画像の貼り付けを行いたい場合やPRの内容自体はブラウザから書きたいという人もいると思います。
そういう場合は、以下のコマンドでブラウザを開いてPRの内容を入力できます。
$ gh pr create -w
他にも list、view などのコマンドでPRを確認したり、 reviewやmerge もできます。
まとめ
今回はリポジトリとPRの操作を試してみましたが、 issue や gist など他にも色々操作することができます。また、aliasやapiを活用すれば、より便利なコマンドを簡単に実行できるので、こちらも合わせて確認したいですね。
僕自身まだ使い始めて間もないので、これから継続して使っていきたいです。
Discussion