OCaml finder

oif is small program as finder, such like fzf, peco. oif is written by pure OCaml.

Install

Use opam to install oif . Currently this package do not merge into opam repository, so you should install locally.

oif always needs migemocaml to build. Sorry for inconvenience.

$ git clone https://github.com/derui/migemocaml
$ cd migemocaml
$ opam install .
$ git clone https://github.com/derui/oif
$ cd oif
$ opam install .

Usage

oif is made for pipe with some inputs.

$ ls | oif

# If you want to use migemo, do the following
$ ls | oif --migemo_dict_directory=<dict directory>
# or
$ export OIF_DEFAULT_MIGEMO_DICT_DIRECTORY=<dict directory>
$ ls | oif

# You can use pipe after oif to process with result
$ ls | oif | sed -e 's/ /-/g'

oif can read content from pipe asynchronously now.

Key bindings

• C-n/C-p
  • move cursor next/previous
• Enter
  • end program and print selected candidate or marked candidates to stdout
• Tab
  • mark current selected candidate
• C-q/C-g
  • quit program with status 130

Options

# If you want to read all info, please do `oif --help` in your shell.

OPTIONS
       --help[=FMT] (default=auto)
           Show this help in format FMT. The value FMT must be one of `auto',
           `pager', `groff' or `plain'. With `auto', the format is `pager` or
           `plain' whenever the TERM env var is `dumb' or undefined.

       --migemo_dict_directory=VAL (absent OIF_DEFAULT_MIGEMO_DICT_DIRECTORY env)
           Directory of migemo directory

       --prompt=VAL (absent OIF_DEFAULT_PROMPT env)
           Prompt of input (Default is 'QUERY> ')

       -q VAL, --query=VAL (absent OIF_DEFAULT_QUERY env)
           Initial query

ENVIRONMENT
       These environment variables affect the execution of oif:

       OIF_DEFAULT_MIGEMO_DICT_DIRECTORY
           Directory of migemo dictionary

       OIF_DEFAULT_PROMPT
           Prompt of input (Default is 'QUERY> ')

       OIF_DEFAULT_QUERY
           Initial query

Development

Build

$ dune build

Test

$ dune test

License

MIT License