Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/essentialkaos/fz

Tool for fuzzing with style 👌
https://github.com/essentialkaos/fz

fuzzing go-fuzz

Last synced: about 1 month ago
JSON representation

Tool for fuzzing with style 👌

Awesome Lists containing this project

README

        


GoReportCard
Codacy Badge
GitHub Actions CI Status
GitHub Actions CodeQL Status

Demo • Installation • Completions • Man documentation • Usage • CI Status • License


`fz` is a simple tool for formatting [`go-fuzz`](https://github.com/dvyukov/go-fuzz) output.

### Usage demo

[![demo](https://gh.kaos.st/fz-111.gif)](#usage-demo)

### Installation

#### From source

To build the `fz` from scratch, make sure you have a working [Go 1.22+](https://github.com/essentialkaos/.github/blob/master/GO-VERSION-SUPPORT.md) workspace (_[instructions](https://go.dev/doc/install)_), then:

```
go install github.com/essentialkaos/fz@latest
```

#### Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/fz/latest):

```bash
bash <(curl -fsSL https://apps.kaos.st/get) fz
```

### Command-line completion

You can generate completion for `bash`, `zsh` or `fish` shell.

Bash:
```bash
sudo fz --completion=bash 1> /etc/bash_completion.d/fz
```

ZSH:
```bash
sudo fz --completion=zsh 1> /usr/share/zsh/site-functions/fz
```

Fish:
```bash
sudo fz --completion=fish 1> /usr/share/fish/vendor_completions.d/fz.fish
```

### Man documentation

You can generate man page for `fz` using next command:

```bash
fz --generate-man | sudo gzip > /usr/share/man/man1/fz.1.gz
```

### Usage

### CI Status

| Branch | Status |
|--------|--------|
| `master` | [![CI](https://kaos.sh/w/fz/ci.svg?branch=master)](https://kaos.sh/w/fz/ci?query=branch:master) |
| `develop` | [![CI](https://kaos.sh/w/fz/ci.svg?branch=develop)](https://kaos.sh/w/fz/ci?query=branch:develop) |

### Contributing

Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines).

### License

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)