README.ja.md

🔍 go-fzf

Fuzzy Finder CLI and Library.

English | 日本語

目次

• 使い方
  • CLI
  • ライブラリ
• ライセンス

使い方

CLI として使用する

go-fzf で何ができるのかを知りたい場合は gofzf CLI を試してください。
gofzf CLI は go-fzf で作られており、 go-fzf のほとんどの機能を利用可能です。

詳しい情報はドキュメントをご参照ください。

ライブラリとして使用する

go-fzf を使用するとカスタマイズ性の高い Fuzzy Finder を簡単に作ることができます。
例えば、たったこれだけのコードで以下のような Fuzzy Finder を作ることができます。

package main

import (
	"fmt"
	"log"

	"github.com/koki-develop/go-fzf"
)

func main() {
	items := []string{"hello", "world", "foo", "bar"}

	f, _ := fzf.New()
	if err != nil {
		log.Fatal(err)
	}

	idxs, err := f.Find(items, func(i int) string { return items[i] })
	if err != nil {
		log.Fatal(err)
	}

	for _, i := range idxs {
		fmt.Println(items[i])
	}
}

詳しい情報はドキュメントをご参照ください。

使用例

examples には go-fzf の使い方の様々な例が用意されています。

ライセンス

MIT