Zenn
🍇

自作CLIツールをzshで快適に使う：パスを通す＆エイリアス設定の手順メモ

に公開
Zsh
tech

自作したCLIツールをzsh環境で快適に使うために、以下の設定を行いました。備忘録としてまとめます。

  • 実行ファイルのパス（PATH）を通す
  • よく使うコマンドにエイリアス（alias）を設定する

設定する目的は以下の通りです。

  • 自作CLIをターミナルからどこでも実行できるようにするには、実行ファイルのパスを通す必要がある
  • よく使うコマンドにはエイリアスを設定することで、操作がよりスムーズになる

1. 実行ファイルのパスを通す

① 実行ファイルを配置するディレクトリを作成する

mkdir -p ~/bin

② CLIツールのバイナリを移動＆実行権限を付与する

mv tasklog ~/bin/
chmod +x ~/bin/tasklog

tasklogは今回作成した実行ファイルです。

③ .zshrc にパスを追加する

export PATH="$HOME/bin:$PATH"

④ 設定を反映する

source ~/.zshrc

⑤ 動作確認

which tasklog
# => /Users/username/bin/tasklog
tasklog --help
# => 使い方が表示されればOK

2. エイリアスを設定する

今回のツールでは実行したカレントディレクトリにデータファイルが作成されるので、データの散逸を防ぐため実行時のディレクトリは固定したいです。毎回そのディレクトリに移動するのは面倒なので、エイリアスでまとめて実行できるようにします。

① .zshrc にエイリアスを定義する

alias tl='cd /Users/username/tasklog-data;tasklog'

② 設定を反映する

source ~/.zshrc

おまけ：エイリアスの管理

現在のエイリアス一覧を表示するには

alias

Discussion