5分で完了！MacのTerminalを劇的にカスタマイズする方法（git branchなど）

2024年8月10日 12:57

Terminalのカスタマイズ

こんにちは。今回は、Terminalのプロンプトを自分好みにカスタマイズする方法を紹介します。開発環境を整えるのって楽しいですよね。Terminalが自分好みになると、作業も捗るものです。

私も普段からTerminalでの作業が多く、少しでも効率的に使いたいと思い、最近話題のStarshipを使ってカスタマイズしてみました。gitの作業ブランチなど、コマンドを叩かずに確認できるのでこれが大変便利！
この記事では、その設定手順や注意点、エラーが出たときの対処法などを紹介します。

なお、環境はmacOSですので、他のOSの方は適宜読み替えてくださいね。

必要なツールのインストール

まずは、Terminalのカスタマイズに必要なツールをインストールします。

1. Homebrewのインストール

Homebrewがまだインストールされていない方は、公式ドキュメントをご覧ください。

2. Nerd Fontのインストール

次に、プロンプトにアイコンを表示させるためのNerd Fontをインストールします。今回はHack Nerd Fontを使います。

brew install --cask font-hack-nerd-font

インストールが完了したら、Terminalのフォント設定で「Hack Nerd Font」を選択してください。これは、Terminalの表示が綺麗に整うために必要な手順です。

3. Starshipのインストール

Starshipは、高速で使いやすいプロンプトカスタマイズツールです。これを使って、プロンプトを自由にデザインしましょう。

brew install starship

インストールが完了したら、次のコマンドで`.zshrc`にStarshipを読み込む設定を追記します。

echo 'eval "$(starship init zsh)"' >> ~/.zshrc
source ~/.zshrc

Starshipの設定

Starshipの設定は、`~/.config/starship.toml`ファイルに書きます。このファイルでプロンプトの見た目を自由にカスタマイズできます。

まずは設定ファイルを作成しましょう。

mkdir -p ~/.config
touch ~/.config/starship.toml

設定ファイル例

以下は、私が使っている`~/.config/starship.toml`ファイルの設定例です。この設定では、ホスト名、ディレクトリ、Pythonのバージョン、Gitブランチがプロンプトに表示されます。各設定には、何をカスタマイズしているのか説明的なコメントを追加しています。

# ~/.config/starship.toml

# ホスト名の表示設定
[hostname]
format = "[$hostname]($style) "  # ホスト名を太字の赤色で表示
style = "bold red"
ssh_only = false  # ローカルでもホスト名を表示する

# ディレクトリの表示設定
[directory]
truncation_length = 3  # ディレクトリ名を3階層まで表示
truncate_to_repo = false  # リポジトリのルートまで省略しない
truncation_symbol = "…"  # 省略する場合の記号
style = "cyan bold"  # ディレクトリ名を太字のシアン色で表示

# Pythonのバージョン表示設定
[python]
format = "🐍 ${version} (${virtualenv}) "  # バージョンと仮想環境名を表示
style = "bold blue"  # Pythonバージョンを太字の青色で表示
disabled = false  # 表示を有効にする

# Gitブランチの表示設定
[git_branch]
symbol = "🌿 "  # ブランチ名の前に表示するシンボル
style = "bold green"  # ブランチ名を太字の緑色で表示

# プロンプトのシンボル設定
[character]
success_symbol = "➜ "  # 成功時のプロンプトシンボル

この設定を保存した後、再度`source ~/.zshrc`を実行して設定を反映させます。

大文字小文字を区別しない補完の設定

次に、タブ補完時に大文字と小文字を区別しない設定を行います。これにより、ファイル名やコマンドの補完がよりスムーズになります。以下の設定を`.zshrc`に追加してください。

# 大文字小文字を区別しないタブ補完の設定
zstyle ':completion:*' matcher-list 'm:{a-zA-Z}={A-Za-z}'

この設定を反映させるには、`.zshrc`を再読み込みします。

source ~/.zshrc

4. エラーが出たときの対処法

設定を反映した際にエラーが出ることがあります。例えば、ホスト名が表示されない場合は、設定が正しくない可能性があります。以下のように、設定ファイルを修正してみましょう。

[hostname]
format = "[$hostname] "
style = "bold red"
ssh_only = false

設定がうまくいかない場合は、`starship explain`コマンドや`STARSHIP_LOG=debug starship prompt`を使ってデバッグするのがおすすめです。

5. デバッグと改善

何か設定がうまくいかない場合、以下のコマンドで問題を特定できます。

starship explain

このコマンドは、現在のプロンプトがどのように構成されているかを説明してくれます。また、詳細なデバッグ情報を確認するには、以下のコマンドを使ってください。

STARSHIP_LOG=debug starship prompt

このデバッグ情報を基に、どのモジュールが表示されていないのか、またその理由を特定できます。

まとめ

Terminalのカスタマイズは、環境構築の楽しさをさらに引き立ててくれます。5分程度で、見た目が大きく変わるとモチベーションも上がりますよね。ぜひ、自分好みにカスタマイズして、快適な作業環境を整えてください。

それでは、良い開発ライフを！