Skip to content

Commit

Permalink
update cli doc
Browse files Browse the repository at this point in the history
  • Loading branch information
koki-develop committed Mar 24, 2023
1 parent 7b6d0df commit 57d7eb2
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions 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
```

0 comments on commit 57d7eb2

Please sign in to comment.