Installation • Command-line completion • Man documentation • Usage • CI Status • Contributing • License

knf is a simple utility for reading values from KNF files.

Installation

From source

To build the knf from scratch, make sure you have a working Go 1.24+ workspace (instructions), then:

go install github.com/essentialkaos/knf@latest

Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from EK Apps Repository:

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

Upgrading

Since version 0.2.0 you can update knf to the latest release using self-update feature:

knf --update

This command will runs a self-update in interactive mode. If you want to run a quiet update (no output), use the following command:

knf --update=quiet

Command-line completion

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

Bash:

knf --completion=bash | sudo tee /etc/bash_completion.d/knf > /dev/null

ZSH:

knf --completion=zsh | sudo tee /usr/share/zsh/site-functions/knf > /dev/null

Fish:

knf --completion=fish | sudo tee /usr/share/fish/vendor_completions.d/knf.fish > /dev/null

Man documentation

You can generate man page using next command:

knf --generate-man | sudo gzip > /usr/share/man/man1/knf.1.gz

Usage

CI Status

Branch	Status
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0