2.5 KiB
fzf in Go
This directory contains the source code for the new fzf implementation in Go. The new version has the following benefits over the previous Ruby version.
- Immensely faster
- No GIL. Performance is linearly proportional to the number of cores.
- It's so fast that I even decided to remove the sort limit.
--sort=Nis no longer required.
- Does not require Ruby and distributed as an executable binary
- Ruby dependency is especially painful on Ruby 2.1 or above which ships without curses gem
Build
# Build fzf executables
make
# Install the executable to ../bin directory
make install
# Build executables for Linux using Docker
make linux
System requirements
Currently prebuilt binaries are provided only for OS X and Linux. The install
script will fall back to the legacy Ruby version on the other systems, but if
you have Go 1.4 installed, you can try building it yourself. (make install)
However, as pointed out in golang.org/doc/install, the Go version may not run on CentOS/RHEL 5.x and thus the install script will choose the Ruby version instead.
The Go version depends on ncurses and some Unix system calls, so it shouldn't run natively on Windows at the moment. But it should be not impossible to support Windows by falling back to a cross-platform alternative such as termbox only on Windows. If you're interested in making fzf work on Windows, please let me know.
Third-party libraries used
- ncurses
- mattn/go-runewidth
- Licensed under MIT
- mattn/go-shellwords
- Licensed under MIT
Contribution
For the moment, I will not add or accept any new features until we can be sure that the implementation is stable and we have a sufficient number of test cases. However, fixes for obvious bugs and new test cases are welcome.
I also care much about the performance of the implementation (that's the reason I rewrote the whole thing in Go, right?), so please make sure that your change does not result in performance regression. Please be minded that we still don't have a quantitative measure of the performance.