utility/

README

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

{{SHORT_NAME}} is {{DESC_README}}.

Installation

From source

To build the {{SHORT_NAME}} from scratch, make sure you have a working Go 1.20+ workspace (instructions), then:

go install github.com/essentialkaos/{{SHORT_NAME}}@latest

Container Image

The latest version of {{SHORT_NAME}} also available as container image on GitHub Container Registry and Docker Hub:

podman run --rm -it ghcr.io/essentialkaos/{{SHORT_NAME}}:latest
# or
docker run --rm -it ghcr.io/essentialkaos/{{SHORT_NAME}}:latest

Prebuilt binaries

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

bash <(curl -fsSL https://apps.kaos.st/get) {{SHORT_NAME}}

Command-line completion

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

Bash:

sudo {{SHORT_NAME}} --completion=bash 1> /etc/bash_completion.d/{{SHORT_NAME}}

ZSH:

sudo {{SHORT_NAME}} --completion=zsh 1> /usr/share/zsh/site-functions/{{SHORT_NAME}}

Fish:

sudo {{SHORT_NAME}} --completion=fish 1> /usr/share/fish/vendor_completions.d/{{SHORT_NAME}}.fish

Man documentation

You can generate man page using next command:

{{SHORT_NAME}} --generate-man | sudo gzip > /usr/share/man/man1/{{SHORT_NAME}}.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