Awesome
<div align="center"> <img src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/logo.png" />fzf-make is a command line tool that executes make target using fuzzy finder with preview window.
🛠️ Features
- Select and execute a make target using fuzzy-finder with a preview window by running
fzf-make! - Execute the last executed target(By running
fzf-make --repeat.) - Command history
- Support
includedirective - (Scheduled to be developed) Support config file
👓 Prerequisites
- (If you install fzf-make via a package manager other than Homebrew) bat
- In the future, we intend to make it work with
catas well, but currently it only works withbat.
- In the future, we intend to make it work with
📦 Installation
macOS
Homebrew
You don't need to install bat because fzf-make will install it automatically via Homebrew.
# install
brew install kyu08/tap/fzf-make
# update
brew update
brew upgrade fzf-make
Arch Linux
fzf-make can be installed from the AUR using an AUR helper. For example:
paru -S fzf-make
NixOS / Nix (package manager)
fzf-make can be run from the repository (latest version)
nix run github:kyu08/fzf-make
Or from the nixpkgs (channel >= 23.05)
nix run nixpkgs#fzf-make
Note You may need to enable experimental feature. In that case, execute the following command to enable them
echo "experimental-features = nix-command flakes" | tee ~/.config/nix/nix.conf
OS-independent method
Cargo
cargo install --locked fzf-make
💡 Usage
Run target using fuzzy finder
- Execute
fzf-makein the directory include makefile(file name should be one ofGNUmakefile,makefile,Makefile) - Select make command you want to execute. If you type some characters, the list will be filtered. <img width="752" alt="demo" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/usage-main.png"> <img width="752" alt="demo" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/usage-type-characters.png">
Run target from history
- Execute
fzf-makein the directory include makefile(file name should be one ofGNUmakefile,makefile,Makefile) - Press
Tabto move to the history pane. - Select make command you want to execute. <img width="752" alt="demo" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/usage-history.png">
Commands Supported
| Command | Description |
|---|---|
fzf-make | Launch fzf-make |
fzf-make --repeat / fzf-make -r / fzf-make repeat | Execute last executed target |
fzf-make --history / fzf-make -h / fzf-make history | Launch fzf-make with the history pane focused |
fzf-make --help / fzf-make help | Show help |
fzf-make --version / fzf-make -v / fzf-make version | Show version |
💻 Development
- Clone this repository
- Change the codes
- Run
make run
To execute test, run make test(needs nextest).
nix
Or you can use nix to create a development shell with the project dependencies.
Within the repo root, execute the following command:
nix develop
👥 Contribution
- Contributions are welcome!
- If you have a Feature request, please create an issue first.
- If you have added fzf-make to some package manager, please let me know. (or please send a PR to add how to install via the package manager in the
README.md) - If you have any questions, feel free to create an issue and ask.