You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
fzf/src
Junegunn Choi c35d98dc42 Nullify --nth option when it's irrelevant 10 years ago
..
algo Reorganize source code 10 years ago
curses Lint 10 years ago
fzf Rewrite fzf in Go 10 years ago
util Reorganize source code 10 years ago
Dockerfile.arch Use Go 1.4.1 to build linux binaries 10 years ago
Dockerfile.centos Use Go 1.4.1 to build linux binaries 10 years ago
Dockerfile.ubuntu Use Go 1.4.1 to build linux binaries 10 years ago
LICENSE Rewrite fzf in Go 10 years ago
Makefile Do not build i386 binary on Travis CI to speed up the process 10 years ago
README.md Update src/README.md 10 years ago
cache.go Lint 10 years ago
cache_test.go Lint 10 years ago
chunklist.go Reorganize source code 10 years ago
chunklist_test.go Lint 10 years ago
constants.go Improved handling of tab characters 10 years ago
core.go Reorganize source code 10 years ago
item.go Lint 10 years ago
item_test.go Fix race conditions 10 years ago
matcher.go Reorganize source code 10 years ago
merger.go Lint 10 years ago
merger_test.go Fix race conditions 10 years ago
options.go Nullify --nth option when it's irrelevant 10 years ago
options_test.go Nullify --nth option when it's irrelevant 10 years ago
pattern.go Reorganize source code 10 years ago
pattern_test.go Reorganize source code 10 years ago
reader.go Reorganize source code 10 years ago
reader_test.go Reorganize source code 10 years ago
terminal.go Improved handling of tab characters 10 years ago
tokenizer.go Nullify --nth option when it's irrelevant 10 years ago
tokenizer_test.go Lint 10 years ago
update_assets.rb Add script for updating release assets 10 years ago

README.md

fzf in Go

fzf in go

This directory contains the source code for the new fzf implementation in Go.

Upgrade from Ruby version

The install script has been updated to download the right binary for your system. If you already have installed fzf, simply git-pull the repository and rerun the install script.

cd ~/.fzf
git pull
./install

Otherwise, follow the instruction as before. You can also install fzf using Homebrew if you prefer that way.

Motivations

No Ruby dependency

There have always been complaints about fzf being a Ruby script. To make matters worse, Ruby 2.1 removed ncurses binding from its standard libary. Because of the change, users running Ruby 2.1 or above are forced to build C extensions of curses gem to meet the requirement of fzf. The new Go version will be distributed as an executable binary so it will be much more accessible and should be easier to setup.

Performance

Many people have been surprised to see how fast fzf is even when it was written in Ruby. It stays quite responsive even for 100k+ lines, which is well above the size of the usual input.

The new Go version, of course, is significantly faster than that. It has all the performance optimization techniques used in Ruby implementation and more. It also doesn't suffer from GIL, so the search performance scales proportional to the number of CPU cores. On my MacBook Pro (Mid 2012), the new version was shown to be an order of magnitude faster on certain cases. It also starts much faster though the difference may not be noticeable.

Differences with Ruby version

The Go version is designed to be perfectly compatible with the previous Ruby version. The only behavioral difference is that the new version ignores the numeric argument to --sort=N option and always sorts the result regardless of the number of matches. The value was introduced to limit the response time of the query, but the Go version is blazingly fast (almost instant response even for 1M+ items) so I decided that it's no longer required.

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.

However, as pointed out in golang.org/doc/install, the Go version may not run on CentOS/RHEL 5.x, and if that's the case, 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 won't be 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.

Build

# Build fzf executables and tarballs
make

# Install the executable to ../bin directory
make install

# Build executables and tarballs for Linux using Docker
make linux

Contribution

For the time being, 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, so please make sure that your change does not result in performance regression. And please be noted that we don't have a quantitative measure of the performance yet.

Third-party libraries used

License

MIT