README.md

Installation • Usage • CI Status • Contributing • License

fmtc is a simple utility for rendering fmtc formatted data. You can use it instead of the echo command to print colored messages.

# Simple formatted message
fmtc "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}"

# Use option -E/--error to print message to stderr
fmtc -E "{r*}There is no user bob{!}"

# You can use stdin as a source of data
echo "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}" | fmtc
# or
fmtc <<< "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}"

# You can print message without colors using -nc/--no-color option
fmtc -nc "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}"

# Also, fmtc supports the NO_COLOR environment variable (https://no-color.org)
NO_COLOR=1 fmtc "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}"

# You can combine the use of fmtc with HEREDOC to reduce the number of fmtc calls
fmtc << EOF

{*}Usage:{!} rpmbuilder-farm {y}{command}{!} {s}arg…{!}

{*}Basic commands{!}

  {y}${CMD_INSTALL}{!} restart-delay{!}  Install farm on the system
  {y}${CMD_UNINSTALL}{!}              Uninstall farm from the system
  {y}${CMD_UPDATE}{!}                 Update all images
  {y}${CMD_USER_ADD}{!} {s}user{!}          Add new user
  {y}${CMD_USER_DEL}{!} {s}user{!}          Remove user and it containers
  {y}${CMD_USER_MOD}{!} {s}user{!}          Modify user public key

{*}Containers commands{!}

  {y}${CMD_START}{!} {s}user{!} {s-}image-name{!}    Start containers for given user
  {y}${CMD_RESTART}{!} {s}user{!} {s-}image-name{!}  Restart containers for given user
  {y}${CMD_STOP}{!} {s}user{!} {s-}image-name{!}     Stop containers for given user
  {y}${CMD_START_ALL}{!}                Start containers for all users
  {y}${CMD_RESTART_ALL}{!}              Restart containers for all users
  {y}${CMD_STOP_ALL}{!}                 Stop containers for all users

{*}Options{!}

  {g}--help{!}, {g}-h{!}     Show this help message
  {g}--version{!}, {g}-v{!}  Show information about version

EOF

Tip

If you are using SublimeText 4 (4075+), we strongly recommend that you install extended Bash syntax highlighting with support for fmtc tags.

Installation

From source

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

go install github.com/essentialkaos/fmtc@latest

From ESSENTIAL KAOS Public Repository

sudo yum install -y https://pkgs.kaos.st/kaos-repo-latest.el$(grep 'CPE_NAME' /etc/os-release | tr -d '"' | cut -d':' -f5).noarch.rpm
sudo yum install fmtc

Prebuilt binaries

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

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

Command-line completion

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

Bash:

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

ZSH:

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

Fish:

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

Man documentation

You can generate man page using next command:

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