Overview

UI tools for processes / functions feedbacks.

Getting Started

• Overview
• Getting Started
  • Documentation
  • Setting up
    • Prerequisites
    • Install
    • Usage
  • Troubleshooting
  • Supported platforms
  • Contributing
  • License

Documentation

The repository defines colors variables from the bash values.

The functions themselves can be used following this example:

func $1

Where "func" is the function used, and "$1" the append text.

Setting up

Prerequisites

• bash environment (zsh, fish, or equivalent should work too.)
• git

Install

Tip

This repository may not be used as a standalone project, but rather as a dependency for a project in need to give feedback about what's happening during execution.

You will only need to clone the repository:

git clone https://github.com/MorganKryze/bash-toolbox.git

Usage

Source the files to access their functions. Like this:

source ./bash-toolbox/src/prefix.sh ; info "tools are installed"

To access it globally, you will need to add the source instruction from your .bashrc (or equivalent) referencing the files with an absolute path.

Troubleshooting

If you cannot access the functions, always check the path to the executable and your location with pwd in your terminal.

Supported platforms

• MacOS
• Linux
• Windows (WSL or VM)

Contributing

If you want to contribute to the project, you can follow the steps described in the CONTRIBUTING file.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.