essentialkaos / knf

Simple utility for reading values from KNF files

Installation • Command-line completion • Man documentation • Usage • Build 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.17+ workspace (instructions), then:

go install github.com/essentialkaos/knf

Prebuilt binaries

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

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

Command-line completion

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

Bash:

sudo knf --completion=bash 1> /etc/bash_completion.d/knf

ZSH:

sudo knf --completion=zsh 1> /usr/share/zsh/site-functions/knf

Fish:

sudo knf --completion=fish 1> /usr/share/fish/vendor_completions.d/knf.fish

Man documentation

You can generate man page using next command:

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

Usage

Usage: knf {options} knf-file property

Options

  --exist, -E        Checks if given param is exist
  --no-color, -nc    Disable colors in output
  --help, -h         Show this help message
  --version, -v      Show version

Examples

  knf file.knf server:ip
  Read server:ip param value

  knf -E file.knf server:ip
  Checks if server:ip param is exist in KNF file

Build Status

Branch	Status
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0