この記事はなに?
- gitのaliasをはじめて設定する人向けの記事です。
- 派生して、新卒や新メンバーの受け入れで教育担当になった人が、「この記事見て設定しておいて」ができる記事になるといいな。
- 「3000文字Tips - 知ると便利なTipsをみんなへ届けよう」への投稿記事
- 対象読者
- はじめてaliasの設定をする人
- 非エンジニアだけれどコマンドでgit操作することになった人
- 新卒などの教育担当になった人
aliasとは
簡単に言うと短縮コマンドを設定できます。
例えば、git status -sb
というコマンドを私は良く使います。
これを git st
と打てば git status -sb
の内容が実行されるように設定しています。
gitのコマンドはオプションを付けることでより便利に利用できます。
ですが、コマンドとオプションを補完なしで毎回入力するのは面倒です。
(※補完する方法は別途ありますが、今回は触れません)
頻繁に使うコマンドを設定しておくと毎日のgit操作が快適になりますよ。
短縮の形も人によって違うので、ぜひ自分が使いやすい形をみつけてください。
gitに不慣れな方への補足
git status
とそのオプションについて軽く説明します。
知っているよという方は読み飛ばして、次の章へ進んで問題ありません。
git status
と打てば、ローカルで変更されたファイルを確認できます。
On branch [ブランチ名]
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: [変更ファイル名]
でも正直表示が長いので、私はgit status -sb
というオプションを利用して、省略表示をしています。
オプションの内容を簡単に説明すると、-s
でstatusで表示される内容を短縮し、-b
でbranch名を表示します。
表示結果は下記のようになります。
## [ブランチ名]
M [変更ファイル名]
毎回 git status -sb
と打つのは手間なので、git st
と打てば git status -sb
が実行できるようにaliasを設定しています。
設定方法
ここからは設定方法について解説します。
前提
- gitをインストールしている
- 隠しファイルを見れるようにしている ※エディタで編集したい人
設定ファイルを開く
aliasを設定する場所は、反映させたい範囲によって異なります。
反映させたい範囲 | 設定ファイル | 備考 |
---|---|---|
システム全体 | /etc/gitconfig | 利用しているパソコン全体で使えます |
ユーザー | ~/.gitconfig | ログインしているユーザーで使えます |
リポジトリ | リポジトリルートディレクトリ/.git/config | 操作しているリポジトリ配下で使えます |
複数箇所に書いた場合、優先度は システム全体 < ユーザー < リポジトリ
となります。
今回は ~/.gitconfig
で解説をしていきたいと思います。
コマンドで開く
ターミナルなどのCUIで操作したい方は、下記のコマンドでファイルを開けます。
git config --global --edit
エディタで開く
VScodeなどのエディタで開きたい方は、隠しファイルを閲覧できる状態にしてからファインダーから直接VScodeで開いてください。
Macの場合 | Winの場合 |
---|---|
~/.gitconfig | C:\\Users\{username}\.gitconfig |
設定する
初めて .gitconfig
を開いた時は何も書いてないと思います。
ここに自分でaliasを書き足していきましょう。
すでに何かしら記入してある場合は、続きに記入してください。
最初に [alias]
と記入してセクションを宣言します。
aliasの記入方法は 短縮コマンド = 通常のコマンド
と記入してください。
例えば先に説明した git status -sb
のaliasは下記のように書きます。
[alias]
st = status -sb
設定が完了したら、保存すれば使うことが可能です。
ターミナルなどでお試しください
何から設定したらいいかわからない方向け
私が思う、最初に登録をおすすめするaliasはこちらです。
良ければご活用くださいませ。
[alias]
st = status -sb
co = checkout
br = branch
ft = fetch
loga = log --graph --oneline
Qiita内にもaliasの記事がいっぱいあるので、とても参考になります。
何かしらこの記事がお役に立てたら幸いです