0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

いまさら雑に最低限学ぶghコマンド

Posted at

はじめに

AIとのコーディングが当たり前になった昨今、かっこいいツールやら、すごいエージェントやら、いろいろありますね。選択肢が多すぎますね。

あまりついていけておらず、長らくコードを書かせるだけの活用をしていました。

表題の件は時代遅れかもしれませんし、すでにご存知の方も多いかもしれません。

それでもすこーしだけ作業が楽になったことをまとめています。私と同じような方に少しでも参考になれば幸いです。

前提

以下くらいのレベルの方向けの内容となっています。

  • github CopilotなりClaude Codeなりのコーディングエージェントを使っているが、コードを書かせるくらいで終わっている方

この記事のこと

私は主にgithub Copilotとclaude codeを利用しています。

これまではコードを書かせて、完成したら手動でcommit、pushをして、WebでPRを作成...みたいなことをしていました。

それを少しだけ改善を目指します。

まずはghコマンドを用いて、CLI上でGithubを操作して。

そしてそれもAIにお任せして、一貫して作業をやってもらいましょう、という内容です。

gitコマンド

gitコマンドは当たり前に使っているかと思いますが、念のため。

ローカルリポジトリに対して

git commit -m "コミットメッセージ"

なんてやりますね。(いまどきはGUIですかね。私もコミットはGUIでやります)

ghコマンド

githubを操作するためのコマンドです。

私はこれまで、commit、pushしたら、githubを開いて、それ以降はGUIでPR作成など操作していました。

それもほとんどghコマンドで行えます。

それもCLIから実行したら、ちょっと快適。vscodeで作業中にブラウザに移動するのもちょっとめんどう。

導入

導入は割愛します。この辺をご確認ください。

導入からご自身のgithubアカウントへの認証も必要になります。

PullRequestの操作

PullRequestを作る

以下のコマンドでできます。

developブランチからmainブランチへのPullRequestの作成です。

gh pr create --base main --head develop --title "ここにタイトル" --body "ここに本文"

説明文を改行する場合はこんな感じ。

gh pr create --base main --head develop \
  --title "PRのタイトル" \
  --body "1行目の文章です。
2行目の文章です。"

コメントをみる

以下でもらった指摘コメントなどを取得できます。

コマンド中の数字は、github上でPRやらissueのNoを指します。

gh pr view 1 --comments

Issueの操作

issueについても操作が可能です。

作る

PRと基本は同じです。

gh issue create --title "タイトル" --body "ここに本文"

見る

特定のissueを見ます。PRと基本は同じです。

gh issue view 1

コメントを見る

以下でコメントを取得できます。

gh issue view 1 --comments

一覧を見る

gh issue list

ブラウザで開く

ghコマンドのview系コマンドには、--webオプションがあります。

これをつけると、CLIで結果を表示する代わりに、ブラウザで該当のページを開いてくれます。

リポジトリをブラウザで開く

gh repo view --web

カレントディレクトリのリポジトリをブラウザで開きます。

Pull Requestをブラウザで開く

gh pr view 1 --web

Issueをブラウザで開く

gh issue view 1 --web

「やっぱりブラウザで見たい」「GUIで操作したい」という場合に、わざわざGitHubを開いて該当のPRやIssueを探す手間が省けます。

CLI作業中にサッとブラウザに切り替えられるので便利です。

何が嬉しい?

ここからが、今回お伝えしたいメリット。

もしgithub Copilotを(私と同じ)コード生成くらいだけで使っている場合、PR作成などいろいろAIにやらせましょう。

上記のコマンドあたりだけでも

  • Issueから対応内容を取得
  • commit、push
  • PR作成
  • 指摘コメントを取得して対応

みたいなことをAIにお任せできます。

とりあえずissueの操作とPRの操作だけでも、個人的には大幅に手作業が削減されました。

もう少し環境を整備する

こちら使っておりますでしょうか。

.github/copilot-instructions.mdにプロジェクト情報などを記載しておくと、Copilotがコンテキストに加えてくれます。

こんな感じで、勝手に読み取ってくれます。
image.png

開発ルールなどに加えて、copilot-instructions.md

  • コミットルール
  • ブランチルール
  • PRに記載する内容

などを記載しておくと、PRなどの作成も統一したルールで行えます。

英語で作ったりされることもなく、コミットやPR作成などをも定めたルールで行えます。

おわりに

ということで、これまで、私自身がコーディングの補助くらいで活用していました。

ちょっとした面倒であるコミットしかり、PR作成などを楽にできないか、という興味から学んだ内容でした。

それでもサクッと学びたい方へ、参考になれば幸いです。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?