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 6e86fee588 Change Merger implementation on --no-sort 10 years ago
..
curses Remove call to ncurses set_tabsize() 10 years ago
fzf Rewrite fzf in Go 10 years ago
Dockerfile.arch Fix i386 build 10 years ago
Dockerfile.centos Build i386 binary as well 10 years ago
Dockerfile.ubuntu Build i386 binary as well 10 years ago
LICENSE Rewrite fzf in Go 10 years ago
Makefile Fix i386 build 10 years ago
README.md Update src/README.md 10 years ago
algo.go Minor refactoring 10 years ago
algo_test.go Rewrite fzf in Go 10 years ago
atomicbool.go Rewrite fzf in Go 10 years ago
atomicbool_test.go Rewrite fzf in Go 10 years ago
cache.go Rewrite fzf in Go 10 years ago
chunklist.go Remove race conditions when accessing the last chunk 10 years ago
chunklist_test.go Reduce memory footprint 10 years ago
constants.go Rewrite fzf in Go 10 years ago
core.go Improve response time by only looking at top-N items 10 years ago
eventbox.go Remove unnecessary delay on non/defered interactive mode 10 years ago
eventbox_test.go Remove unnecessary delay on non/defered interactive mode 10 years ago
item.go Improve response time by only looking at top-N items 10 years ago
item_test.go Improve response time by only looking at top-N items 10 years ago
matcher.go Improve response time by only looking at top-N items 10 years ago
merger.go Change Merger implementation on --no-sort 10 years ago
merger_test.go Change Merger implementation on --no-sort 10 years ago
options.go Rewrite fzf in Go 10 years ago
options_test.go Rewrite fzf in Go 10 years ago
pattern.go Reduce memory footprint 10 years ago
pattern_test.go Rewrite fzf in Go 10 years ago
reader.go Remove extraneous quote-escape 10 years ago
reader_test.go Rewrite fzf in Go 10 years ago
terminal.go Constrain cy in vmove() 10 years ago
tokenizer.go Minor refactoring 10 years ago
tokenizer_test.go Fix index out of bounds error during Transform 10 years ago
util.go Reduce memory footprint 10 years ago
util_test.go Rewrite fzf in Go 10 years ago

README.md

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=N is 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

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.

License

MIT