Rust製ツールでおしゃれなターミナル環境を作る【Starship ✕ exa】

commits8 min read

はじめに

エンジニアとして仕事をする中でPCからターミナルを使って作業することがとても多いです。エンジニアをしている人はこだわりが強く、それぞれ自分の作業しやすい環境を確立させている人が多い印象です。私も毎日使うものや作業環境は日々使いやすいようにカスタマイズするのが好きでいろんなツールについて常日頃から情報収集しています。

エンジニアに限らず、日々使うものをこだわったり、自分の使いやすいようにカスタマイズすることでやる気が高まり作業効率のアップ、生産性の向上に繋がります

最近、GitHubなどでRust製のコマンドやプロンプトが注目されているのが気になりリポジトリを眺めているうちに「ターミナルをもっとおしゃれに使いたい」と思いが強くなりました。そこで今回は、StarshipというRust製のプロンプトとRust製コマンドexaを活用してモダンかつ軽量、おしゃれなターミナル、シェル環境を構築してみました。

今回作成したものがこちらです。

starship x exa で作成したターミナル画像
プロンプトはStarship、アイコンツリー表示にexaを使用

Starshipで作業ブランチ名とNode.jsのバージョンを表示し、exaを使ってアイコン付きのツリー表示でReactのプロジェクトを開いた様子です。カラフルな表示とアイコンフォントで視認性を上げつつ、全体的にモダンな雰囲気になりました。

またターミナルのテーマにはDraculaを使用しています。今回使用するStarshipと色合いが似ており、テーマと合わせることで全体的に雰囲気がでておしゃれになります。DraculaはWindows TerminalやiTerm2など多くのツールに対応しています。

https://draculatheme.com/

今回使用する環境

今回は以下の環境、バージョンにてそれぞれターミナルを構築しました。

[Windows]

  • Windows Terminalバージョン: 1.7.1033.0
  • WSL2(Ubuntu 20.04 LTS)
  • Zsh 1.56.0

[Mac]

  • iTerm2 Build 3.4.8
  • macOS BigSurバージョン11.3
  • Zsh 1.56.0

私は、開発でWindowsとmacOSを両方使用しておりターミナルツールとしてそれぞれWindowsではWindows Terminal、MacではiTerm2を使用しています。Rust製ツールは互換性が重視されており、異なる環境であっても簡単に同じような環境を作成できるのが大きなメリットです。

Starshipを導入する

まず、Rust製のシェルプロンプト「Starship」を導入します。

公式サイトはこちらです。

https://starship.rs/ja-jp/

「互換性優先」「Rust製」「カスタマイズ可能」という三拍子揃ったモダンなプロンプトになります。サイトを見てすぐわかりますが、公式が日本語のドキュメントを用意してくれています。デフォルトでカラフルな表示と絵文字の表示をしてくれるおしゃれなプロンプトです。互換性優先で設計されており、OSやシェルを選ばずにインストールできるため複数の端末で同じ環境を揃えやすい、乗り換えやすいというメリットがあります。

インストール

公式サイトにそれぞれの環境でのインストールが詳しく紹介されているので簡潔にまとめます。

WSL2でUbuntuなどを利用している場合は以下のスクリプトを使ったインストールが簡単です。

$ sh -c "$(curl -fsSL https://starship.rs/install.sh)"

✓ Starship installed 表示されればインストールは完了です。またこのやり方でインストールした場合、Starshipの更新も同じコマンドで行います。アップデートする際は設定ファイルを変えることなく環境を引き続きながらバージョンを置き換えてくれます。

またMacなどでパッケージ管理にHomebrewを使っている場合は以下のコマンドでもインストールできます。

$ brew install starship

初期設定:Starshipの有効化

Starshipを有効にするたの処理をシェルプロファイルへ記述する必要があります。

シェルにZshを使用している場合は以下のようにします。

zsh
# .zshrcの末尾に追記
echo eval "$(starship init zsh)" >> ~/.zshrc

# シェルの再読み込み
source ~/.zshrc

Bashを使用している場合は以下のようになります。

bash
# .bashrcの末尾に追記
echo eval "$(starship init bash)" >> ~/.bashrc

# シェルの再読み込み
source ~/.bashrc

シェルの再読み込みをすることでStarshipが有効になり以下のような表示に変わります。

# デフォルトの表示
~
❯

eval "$(starship init zsh)"は必ずファイルの末尾に記述してある必要があります。シェルを再起動しても有効にならない場合は記述位置を見直して見てください。

初期設定:フォントの導入

Starshipはアイコンフォントに対応しているため使用しているフォントがアイコンフォントに対応していないと一部文字化けする可能性があります。公式はNerdFontの導入を推奨しているため、Nerdフォントが手元にない場合は以下から探してみてください。また後述するexaというコマンドもアイコンフォントに対応しているため、導入することをおすすめします。

https://www.nerdfonts.com/

私は、たわら様が開発しているプログラミングフォント「白源(はくげん / HackGen)」をターミナルのフォントに使用しています。

https://github.com/yuru7/HackGen

NerdFontを追加した「HackGenNerd Console」というフォントがあるため、こちらをインストールして使用することでアイコンフォントも問題なく表示できます。またプログラミングフォントのため文字の識別がしやすい点もおすすめです。

Starshipのカスタマイズ

Starshipはデフォルトでもアイコンフォントの表示やカラフルな表示に対応しており便利なのですが、設定ファイルを作成して使用することでより細かい設定が可能となります。

$ starship config

とすることで~/.configの下にstarship.tomlという設定ファイルが作成され開かれます。

設定できる項目がかなり多く、自由なカスタマイズが可能です。詳しくは設定 | Starshipを見てみてください。上記の画像では以下の設定をしています。

starship.toml
# 空行追加
add_newline = true

# タイムアウト時間
scan_timeout = 10

# 記号の設定
[character]
success_symbol = "[▶](bold green)" # コマンド成功時
error_symbol = "[▶](bold red)"    # コマンド失敗時

exaを導入する

exaとはLinuxでおなじみのlsを拡張したコマンドになります。こちらもRust製でとても扱いやすいものになっております。デフォルトでカラフルな表示とオプションを使用した詳細表示に対応しており前述したStarshipととても相性がいいです。

GitHubリポジトリはこちらになります。

https://github.com/ogham/exa

exaコマンドはインストール方法が多数ありディストリビューションによって大きく異なります。この記事内ではHomebrewを使用したインストールとCargoを使用したインストールを紹介します。

Homebrewを使用したインストール

パッケージ管理にHomebrewを使用している場合は以下のコマンドでインストールできます。

$ brew install exa

WSL2でUbuntuを使用している場合であってもHomebrewを導入することで同じようにインストールできます。私はWSL2においてHomebrewを導入した上でexaコマンドを導入しています。WSL2上のUbuntu20.04 LTSにHomebrewを導入するやり方は過去にこちらの記事にて紹介しています。

Cargoを使用したインストール

Rustのビルドシステム兼パッケージマネージャーのCargoを使用してexaを導入する方法です。

Cargoを使用するためにRustの環境を作る必要があるのですが、今回はrustupというツールを使い簡単に始めます。

https://github.com/rust-lang/rustup/blob/master/README.md

rustupとはRustの公式ドキュメント内でも推奨されているツールで、ワンライナーでRust環境構築を簡単に行えるスグレモノです。以下のワンライナーを実行してRustをインストールできます。

# rutupをインストール
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh

インストールの途中で質問されたらエンターを押して続行します。デフォルトで1の(Proceed with installation)が選択されます。そのままでも問題ありませんが、カスタムインストールを行う場合は適宜選択を変えてください。

ターミナル上にRust is installed now. Great!と表示されればインストールは成功です。

この状態でシェルにリログインすると自動的にパスが通ります。すぐにパスを通して使いたい場合は、sourceコマンドを使い以下のようにすると自動的にパスを通してくれます。

# rustupが用意してくれているスクリプトを実行してパスを通す
source $HOME/.cargo/env

インストールが終わったらrustupのバージョンを確認してみます。パスが無事に通っているとcargoコマンドが使用できるようになっています。

以下のコマンドでバージョンを確認し、アップデートがあれば最新の状態にアップデートしておきます。

# rustupのバージョンを確認 (Vは大文字なので注意)
$ rustup -V

# rustupを最新にアップデート
$ rustup update

# rustup自体を最新にアップデート
$ rustup self update

パスが通るとパッケージ管理ツールのCargoが使用できるようになり、Cargo経由でexaを導入できます。

# exaのインストール
$ cargo install exa

Ubuntuなどの環境によってはerror: linker cc not foundとなりexaのビルドに失敗する場合があります。これはgccとその依存関係がないことによるエラーのためapt install build-essentialで必要なコンパイラをインストールした上で再試行してみてください。

exaを使ってみる

exaはlsコマンドと同じような感覚で使用できます。ターミナルで以下のように入力するだけでファイル名をカラフルに表示してくれます。

# exaを使用してファイルをリスト表示
$ exa

lsコマンドの代わりにexaを使用することで全体的に文字をカラフルに表示してくれるためターミナルが一気に華やかになります。

またexaはオプションがかなり多く、オプションを組み合わせて柔軟な表示ができのも魅力です。
exaに続けてオプションを指定するのですが、オプションが覚えきれないくらい多いので詳しくは公式のReadMeを参考にしてみてください。

また私はlsコマンドに慣れていることもあり、同じように使用したいので私はexaコマンドに対してエイリアスを設定しています。

エイリアス設定でさらにexaを活用する

lsコマンドと同じように使えると聞いてピンときた人も多いのではないでしょうか。exaはエイリアスと組み合わせることで本領を発揮します。
前述したとおりexaはオプションがとても多く覚えて毎回入力するのは大変なので、lsコマンドに対してエイリアスを設定することでlsコマンドと同じような感覚で使用できるようになります。

私はlsコマンドと同じような使い方を保ちながらexaの恩恵を受けるために以下のようなエイリアスを設定しています。

.zshrc
if [[ $(command -v exa) ]]; then
  alias e='exa --icons --git'
  alias l=e
  alias ls=e
  alias ea='exa -a --icons --git'
  alias la=ea
  alias ee='exa -aahl --icons --git'
  alias ll=ee
  alias et='exa -T -L 3 -a -I "node_modules|.git|.cache" --icons'
  alias lt=et
  alias eta='exa -T -a -I "node_modules|.git|.cache" --color=always --icons | less -r'
  alias lta=eta
  alias l='clear && ls'
fi

内容としてはexaコマンドがインストールされている環境でのみ有効になるエイリアスとしています。

lsをベースに、ファイルの種類ごとにアイコンを表示するオプション--iconsを付けてエイリアスにしています。また--gitオプションを付与することでGitのファイル管理ステータスもリストに反映してくれるようになります。

またコマンドにtを混ぜることでツリー表示できるようにしています。
exaでのファイルツリー表示でもアイコンを合わせて表示するためにオプションを組み合わせています。ここまでくるとオプションがかなり長くなってしまいます。

そこでエイリアスを活用することでlsコマンドの上位互換としての運用が簡単にできるようになりました。

エイリアスの設定例としてはこちらのサイトを参考にカスタマイズさせていだたきました。わかりやすい解説ありがとうございます。

https://tombomemo.com/exa-install-settings/

exaはオプションを組みわせることで柔軟なファイル表示ができるので、各々使いやすいようにエイリアスを作成してみてください。

おわりに

今回は、おしゃれなターミナルというテーマでターミナルとシェルのカスタマイズをしてみました。ターミナル環境をカスタマイズすることで気分転換にもなりターミナルを開くたびにモチベーションが高まるように感じます。また作業環境にこだわるという点で生産性が上がるのを体感することが出来ました。

Rust製のツールを初めて使いましたが、互換性が高かったり、安全かつ高速だったりとメリットが多く更に調べて取り入れていきたいと感じました。この記事をきっかけに、モダンな技術で柔軟にカスタマイズできるターミナルを簡単に構築できることに少しでも魅力を感じてもらえたら幸いです。

最後まで読んでいただきありがとうございました。

参考

GitHubで編集を提案

Discussion

ログインするとコメントできます