PowerShell+fzfでコマンド入力支援
最近はターミナルベースで作業することが多く、ターミナル環境を良くするために調整を繰り返している日々です.
正直なところ、コマンドを覚えるのが大変で 結構しんどいなと思っています.基本としてなるべくタイプ量を減らしたいのでエイリアスやスニペットツールを合わせて利用しているのですが、それらもコマンドを覚える必要があります.今、作業している環境で使っているコマンド群と、別の作業で使うコマンド群が異なっていると、切り替えがなかなか追いつきません.少し時間が空くとなおさらです.そこでチートシートやメモツールなどを参照したりもするのですが、もう少しなんとかしたいところです.
本記事では、WindowsにおいてPowerShellとfzf(fuzzy finder)を使って、ターミナル上でコマンド入力支援環境を構築する方法についてまとめておきます.ちなみに、これは正月のお休み中に構築したもので、私でもまだ検証段階中であることをご了承ください.次の環境で試しています.
Windows11 Pro 22H2
Windows Terminal 1.15.3466.0
fzf 0.33.0 (e03ac31)
また PowerShell のバージョンは次のようになっています.
> $PSVersionTable
Name Value
---- -----
PSVersion 7.3.1
PSEdition Core
GitCommitId 7.3.1
OS Microsoft Windows 10.0.22621
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
PSReadLine
を使います.PowerShellのバージョンが7.3
以上であれば標準でインストールされています.また、fzf のインストールについては触れませんので各自インストールしてパスを通してください.あと、Rust製のツールを使いますので、cargo
が使える環境を前提としています.
はじめに
実はすでに先人がコマンド入力支援ツールを開発しています.
denisidoro / navi - GitHubAn interactive cheatsheet tool for the command-line
navi
はRust製のコマンドライン入力支援ツールです.これを使いたかったのですが、Windows環境への対応はよろしくありません.実行は出来ますが、コマンドが bash だったりするのでそのままでは使えません.一応、カスタマイズでシェルを指定することが出来ますが、例えばPowerShellを指定すると毎回プロファイルの読み込みが入ってレスポンスが悪いですし、そもそもカスタマイズがまだ実験的機能になっています.あとは、チートシートをダウンロードしても内部的にCドライブでしか反応しないというちょっとよくわからんことになっています.カスタマイズでパスを指定できるんですが、試した感じ上手くいきませんでした.まだまだWindowsでは使いづらいようです.公式のIssueでも進捗は無い感じです.
Issues | denisidoro / navi - GitHubSupport Windows (cmd/Powershell) #40
ただ、このツールにはとてもインスパイアされました.
それなら自分で作ろう
ということで、自分で navi を作ります.ただ、Rustで作るとかそういうことはせず、PowerShell(+PSReadLine)とfzf、さらに他のツールと連携して構築します.
次のようなものを作ります.
チートシートデータ (YAML)
まず、チートシートのデータを作成します.今回はYAMLを採用しました.JSONでもいいのですが、今回のように数個のキーを持つハッシュとそれらの配列という単純な階層ではYAMLの方が見やすいかなと思いました.ただ、最終的にPowerShell上でハッシュテーブルとしてデータが持てればいいので、JSONでも構いませんし、JSONならPowerShell標準でサポートされています.
それでは、YAMLファイルを適当に作成します.場所はユーザーフォルダで、名前は navi.yaml
とします
$env:userprofile\navi.yaml
中身は次のような感じになります.
items:
# general
- echo_hello:
description: Echo 'Hellom, World'
command: echo Hello, World!
# git
- git_init:
description: Initialize a git repository
command: git init
- git_clone:
description: Clone a git repository
command: git clone <branch_name> <repository> <clone_directory>
...
items
配列の中にコマンドを1つずつ定義していきます.コマンドはキー名とdescription
、command
を持ちます.区切り文字としてタブを使いますので、タブは含 めないようにします.あと、日本語など英語以外は考慮していません.
次に、このファイルを読み込みます.PowerShellでのYAML読み込みは powershell-yaml
を使います.以下を参考にしました.
PowerShellでYAMLを扱う - QiitaPowerShellでYAMLを扱う
最初に powershell-yaml
をインストールします.
Install-Module powershell-yaml
そして navi.yaml
を読み込んで ハッシュテーブルに変換します.
$data = ConvertFrom-Yaml (Get-Content -raw $env:USERPROFILE\navi.yaml)
これでチートシートデータをPowerShellで扱えます.例えば次のように参照します.
function navi() {
$data = ConvertFrom-Yaml (Get-Content -raw $env:USERPROFILE\navi.yaml)
$data.items.keys | ForEach-Object {
Write-Output ("{0}`t{1}`t{2}" -f $_, $data.items.($_).description, $data.items.($_).command)
}
}
> navi
echo_hello Echo 'Hellom, World' echo Hello, World!
git_init Initialize a git repository git init
git_clone Clone a git repository git clone <branch_name> <repository> <clone_directory>
git_fetch Fetch a git repository git fetch
...
Visual Studio Codeのスニペットを使うと登録が楽になります.例えば次のようになります.
{
"navi": {
"prefix": "navi",
"body": [
"- $1:",
" description: $2",
" command: $3"
],
"description": "Create an item for navi"
}
}
fzf
次に、チートシートデータを fzf に渡します.
まずは、普通に処理すると次のようになります.
function navi() {
$data = ConvertFrom-Yaml (Get-Content -raw $env:USERPROFILE\navi.yaml)
$data.items.keys | ForEach-Object {
Write-Output ("{0}`t{1}`t{2}" -f $_, $data.items.($_).description, $data.items.($_).command)
}
| fzf --reverse
}
--reverse
は入力のすぐ下に表示するオプションです.デフォルトではターミナルの一番下に表示されます.これを実行すると次のようになります.
これでは流石に使いづらいので調整します.fzfのプレビュー機能を使って選択中の説明やコマンドを見やすくします.
function navi() {
$data = ConvertFrom-Yaml (Get-Content -raw $env:USERPROFILE\navi.yaml)
$data.items.keys | ForEach-Object {
Write-Output ("{0}`t{1}`t{2}" -f $_, $data.items.($_).description, $data.items.($_).command)
}
| fzf --reverse --preview 'echo {}'
}
実行すると次のようになります.
どんどん調整していきましょう.fzf のpreviewオプションについては以下を参考にしました.
fzfのpreview関連のオプション調べてみた - Zennfzfのpreview関連のオプション調べてみた
まず、プレビューは右側ではなく上側に表示します.--preview-window
で指定します.
function navi() {
$data = ConvertFrom-Yaml (Get-Content -raw $env:USERPROFILE\navi.yaml)
$data.items.keys | ForEach-Object {
Write-Output ("{0},{1},{2}" -f $_, $data.items.($_).description, $data.items.($_).command)
}
| fzf --preview 'echo {}' --preview-window=up:40% --reverse
}