From 57d7eb2843076bb8692b9f157d9a60e7f7645106 Mon Sep 17 00:00:00 2001 From: koki-develop Date: Fri, 24 Mar 2023 22:38:43 +0900 Subject: [PATCH] update cli doc --- docs/cli/README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/cli/README.md b/docs/cli/README.md index e9b9108..238af3a 100644 --- a/docs/cli/README.md +++ b/docs/cli/README.md @@ -1,3 +1,38 @@ # Using as a CLI 🚧 WIP 🚧 + +- [Installation](#installation) +- [Usage](#usage) + +## Installation + +### Homebrew + +```console +$ brew install koki-develop/tap/gofzf +``` + +### `go install` + +```console +$ go install github.com/koki-develop/go-fzf/cmd/gofzf@latest +``` + +### Releases + +Download the binary from the [releases page](https://github.com/koki-develop/go-fzf/releases/latest). + +## Usage + +```console +$ gofzf --help +Usage: + gofzf [flags] + +Flags: + -h, --help help for gofzf + -l, --limit int maximum number of items to select (default 1) + --no-limit unlimited number of items to select + -v, --version version for gofzf +```