GitHub CLIを使って、生産性を爆上げする
記事の内容
Github CLIを使って、効率的にGithubの操作をする方法を紹介します。
記事を読むと得られるもの
- GitHub CLIとは何か？
- GitHub CLIのInstall方法
- GitHub CLIの使い方
- GitHub CLIの便利コマンド
対象読者
- Githubを利用する全ての人
記事の長さ
1分で読めます
GitHub CLIとは
GitHub CLIとは、Githubをターミナルから操作するためのツールです。
わざわざブラウザを開いてぽちぽちするのは時間がもったいないため、Terminal上で完結するCLIはとても便利です。
AWSも、AWSコンソールを開かずに、CLIでリソースの取得や作成、更新ができます。
それと同じようなツールです。
Setup
Install
Macの場合、brewコマンドでinstall可能です。
$ brew install gh
Login
Installが完了したら、Githubアカウントと紐付けを行います。
Terminalで、gh auth loginと入力し、アナウンスに従って、ログインを完了してください。(SSH public keyのアップロードを聞かれますが、すでにgithubを利用している方は必要ありません。)
$ gh auth login
? What account do you want to log into? GitHub.com
? What is your preferred protocol for Git operations? SSH
? Upload your SSH public key to your GitHub account? Skip
? How would you like to authenticate GitHub CLI? Login with a web browser
※上記の選択肢を選べば、ブラウザからログイン可能です。
コマンド集
issue関連
issue 一覧取得
githubで管理されているディレクトリに移動し、以下コマンドを実行すると、そのリポジトリにあるissueを一覧表示できます。
$ gh issue list
Showing 9 of 9 open issues in rara-tan/...
ID TITLE LABELS UPDATED
#51 xxx about 16 days ago
...
便利コマンド集
ここでは、Github CLIを使った方が、ブラウザでポチポチするよりも便利なコマンドを紹介します。
Issue作成
プログラミングの実装中に、「あ、これ直した方がいいな。忘れないように、issueにしておこう」っていうタイミングありますよね？
そんな時に、ブラウザを開いて、issue作成をしていると、作業が中断されてしまいます。
以下のコマンドを利用すれば、ターミナル上で新たなissueが作成できるため、エディタから離れずにGithub上にissueを作成できます。
$ gh issue create --title "Create xxxx"
Creating issue in rara-tan/zenn-github-cli-basic
? Body <Received>
? What's next? Submit
https://github.com/rara-tan/zenn-github-cli-basic/issues/1
リポジトリ作成
zennの記事を書く際に、サンプルコードとして新たにrepositoryを作成することが頻繁にあります。
その度に、ブラウザを開いて、画面で新repositoryを作成するのは手間です。
そのため、以下のコマンドで、ターミナルからリポジトリ作成を行なっています。
$ gh repo create zenn-github-cli-basic --public
✓ Created repository rara-tan/zenn-github-cli-basic on GitHub
これで、以下のpublic repoを作成することができました。
このように、CLIを使うことで、ブラウザを開いてポチポチする手間がなくなります。
まとめ
以上のように、Github CLIを使うと、様々なGitHubに関するアクションが効率化できます。
Githubはエンジニアなら高頻度で使うツールなので、CLIで効率化していきましょう！
note
勉強法やキャリア構築法など、エンジニアに役立つ記事をnoteで配信しています。
Discussion