Made with 💝 for

This repository includes a library of shell functions that are intended to be used as part of other Shell Scripting software development projects or used interactively as Shell functions sourced from an interactive Shell.

Some functions require Bash Shell v4.4 or newer to be installed in the system.

The file lib/force-xdg-basedirs.sh actually don't follow the standards of this library. This file is intended to be sourced from an interactive session to force some applications to abide by the XDG Base Directory Specification.

📂 lib has Shell scripts containing functions to be sourced
📂 bin has independent executable scripts that can be added to PATH directly
📂 src contain additional executables used during development
⊢ 📂 appbuilder Experimental Python library for building apps
📂 tests contain tests for both functions and executables
⊢ 📄 test-app-*.py tests for individual executables
⊢ 📄 test-*.bats tests for functions loaded in a Bash Shell

Check the dependency graph in docs/dependency_graph.md.

Independent executables can be found in the bin directory. Copy files to a directory in your PATH to find them automatically when you type the name of the tool in your Shell.

Recommended directory: /usr/local/bin for system-wide installation or ${HOME}/.local/bin for user-only installation.

Function files can be found in the lib directory. Copy individual files to your project and source them from your scripts.

All scripts in the bin directory are formatted in a way to be executed directly from the internet if needed.

E.g. for calling dfh script.

\curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/luciorq/shell-lib/main/bin/dfh | bash

• Common Bash pitfalls
• Parsing ls ouput can be really dangerous
• Why you don't read lines with for

Source with caution and have fun!