Simplistic interfacting filtering tool

peco is based on percol. The idea is that percol was darn useful, but I wanted a tool that was a single binary. peco is written in Go, and as of this writing only implements the basic filtering feature (mainly because that's the only thing I use -- you're welcome to send me pull requests to make peco more compatible with percol).

peco can be a great tool to filter stuff like logs, process stats, find files, because unlike grep, you can type as you think and look through the current results.

Demos speak more than a thousand words! Here's me looking for a process on my mac. As you can see, you can page through your results, and you can keep changing the query:

Here's me trying to figure out which file to open:

When you combine tools like zsh, peco, and ghq, you can make managing/moving around your huge dev area a piece of cake! (this example doesn't use zsh functions so you can see what I'm doing)

Search results are filtered as you type. This is great to drill down to the line you are looking for

Multiple terms turn the query into an "AND" query:

When you find that line that you want, press enter, and the resulting line is printed to stdout, which allows you to pipe it to other tools

Case sensitive mode can be toggled on/off

I have been told that peco even works on windows :)

If you're on OS X and want to use homebrew, use my custom tap:

brew tap lestrrat/peco
brew install peco

If you want to go the Go way (install in GOPATH/bin) and just want the command:

go get github.com/lestrrat/peco/cmd/peco

If you can read Japanese, here's one cool usage using ghq

Basically, you can define a simple function to easily move around your source code tree:

function peco-src () {
    local selected_dir=$(ghq list --full-path | peco --query "$LBUFFER")
    if [ -n "$selected_dir" ]; then
        BUFFER="cd ${selected_dir}"
        zle accept-line
    fi    
    zle clear-screen
}         
zle -N peco-src

Or to easily navigate godoc for your local stuff:

function peco-godoc() { 
    local selected_dir=$(ghq list --full-path | peco --query "$LBUFFER")
    if [ -n "$selected_dir" ]; then
        BUFFER="godoc ${selected_dir} | less"
        zle accept-line 
    fi 
    zle clear-screen 
}
    
zle -N peco-godoc 

Display a help message

Specifies the default query to be used upon startup. This is useful for scripts and functions where you can figure out before hand what the most likely query string is.

Pass peco a configuration file, which currently must be a JSON file. If unspecified, it will read ~/.peco/config.json by default (if available)

By default peco starts in case insensitive mode. When this option is specified, peco will start in case sensitive mode. This can be toggled while peco is still in session.

By default configuration file in ~/.peco/config.json will be searched. You may also pass an arbitrary filename via the --rcfile option

Currently keymaps and styles are supported.

Example:

{
    "Keymap": {
        "C-p": "peco.SelectPrevious",
        "C-n": "peco.SelectNext"
    }
}

For now, styles of following 3 items can be customized in config.json.

{
    "Style": {
        "Basic": ["on_default", "default"],
        "Selected": ["underline", "on_cyan", "black"],
        "Query": ["yellow", "bold"]
    }
}

• "black" for termbox.ColorBlack
• "red" for termbox.ColorRed
• "green" for termbox.ColorGreen
• "yellow" for termbox.ColorYellow
• "blue" for termbox.ColorBlue
• "magenta" for termbox.ColorMagenta
• "cyan" for termbox.ColorCyan
• "white" for termbox.ColorWhite

• "on_black" for termbox.ColorBlack
• "on_red" for termbox.ColorRed
• "on_green" for termbox.ColorGreen
• "on_yellow" for termbox.ColorYellow
• "on_blue" for termbox.ColorBlue
• "on_magenta" for termbox.ColorMagenta
• "on_cyan" for termbox.ColorCyan
• "on_white" for termbox.ColorWhite

• "bold" for termbox.AttrBold
• "underline" for termbox.AttrUnderline
• "blink" for termbox.AttrReverse

First, fork this repo, and get your clone locally.

1. Make sure you have go 1.x, with GOPATH appropriately set
2. Run go get github.com/jessevdk/go-flags
3. Run go get github.com/mattn/go-runewidth
4. Run go get github.com/nsf/termbox-go

Note that we have a Godeps file in source tree, for now it's just there for a peace of mind. If you already know about godep, when you may use that instead of steps 2~4

Then from the root of this repository run:

go build cmd/peco/peco.go

This will create a peco binary in the local directory.

Test it. In doing so, we may change the repo structure

Implement all(?) of the original percol options

• Daisuke Maki (lestrrat)
• Shinya Ohyanagi
• syohex
• Takashi Kokubun
• cho45
• cubicdaiya
• mattn
• swdyh

Obviously, kudos to the original percol: https://github.com/mooz/percol Much code stolen from https://github.com/mattn/gof