https://github.com/fchastanet/bash-tools-framework
https://github.com/fchastanet/bash-tools-framework
bash bash-script framework
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/fchastanet/bash-tools-framework
- Owner: fchastanet
- License: mit
- Created: 2022-11-27T12:20:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-02-12T22:43:05.000Z (about 2 months ago)
- Last Synced: 2026-02-13T07:48:30.287Z (about 1 month ago)
- Topics: bash, bash-script, framework
- Language: Shell
- Homepage: https://fchastanet.github.io/bash-tools-framework/
- Size: 3.05 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bash-tools-framework
> **_NOTE:_** **Documentation is best viewed on
> [https://bash-tools-framework.devlab.top](https://bash-tools-framework.devlab.top/)**
[](https://github.com/fchastanet/bash-tools-framework/releases)
[](https://github.com/fchastanet/bash-tools-framework/blob/master/LICENSE)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/fchastanet/bash-tools-framework/actions/workflows/main.yml?query=branch%3Amaster)
[](https://opensource.box.com/badges "Project status")
[](https://deepsource.io/gh/fchastanet/bash-tools-framework/?ref=repository-badge)
[](https://deepsource.io/gh/fchastanet/bash-tools-framework/?ref=repository-badge)
[](https://isitmaintained.com/project/fchastanet/bash-tools-framework "Average time to resolve an issue")
[](https://isitmaintained.com/project/fchastanet/bash-tools-framework "Percentage of issues still open")
- [1. Key Features](#1-key-features)
- [2. Quick Links](#2-quick-links)
- [3. Related Projects](#3-related-projects)
- [4. Acknowledgements](#4-acknowledgements)
Welcome to the Bash Tools Framework documentation. This framework provides a comprehensive collection of bash functions
and commands that help you lint files, generate shell documentation, compile bash files, and much more.
> **_TIP:_** Checkout related projects of this suite
>
> - [My documents](https://devlab.top/)
> - **[Bash Tools Framework](https://bash-tools-framework.devlab.top/)**
> - [Bash Tools](https://bash-tools.devlab.top/)
> - [Bash Dev Env](https://bash-dev-env.devlab.top/)
> - [Bash Compiler](https://bash-compiler.devlab.top/)
## 1. Key Features
- **150+ Unit-Tested Functions**: Organized by namespace (Array, File, Git, Docker, Database, etc.)
- **Custom Bash Compiler**: Generate standalone executables from YAML definitions
- **Extensive Testing**: Multi-version Bash testing (4.4, 5.0, 5.3 on Ubuntu and Alpine)
- **Build Tools**: Linting and testing infrastructure with pre-commit hooks
## 2. Quick Links
- [Framework Guides](https://bash-tools-framework.devlab.top/docs/guides/) - Learn about framework features
- [Commands](https://bash-tools-framework.devlab.top/docs/commands/) - Available command-line tools
- [Framework Documentation](https://bash-tools-framework.devlab.top/docs/framework-overview/) - Complete function
reference
- [Best Practices](https://bash-tools-framework.devlab.top/docs/guides/best-practices/) - Bash development best
practices
- [Pre-commit Hooks](https://bash-tools-framework.devlab.top/docs/pre-commit-hooks/) - Available pre-commit hooks
## 3. Related Projects
This framework is part of a suite of projects:
- [My Documents](https://devlab.top/)
- [Bash Tools](https://bash-tools.devlab.top/)
- [Bash Dev Env](https://bash-dev-env.devlab.top/)
- [Bash Compiler](https://bash-compiler.devlab.top/)
## 4. Acknowledgements
Like so many projects, this effort has roots in many places.
I would like to thank particularly Bazyli Brzóska for his work on the project
[Bash Infinity](https://github.com/niieani/bash-oo-framework). Framework part of this project is largely inspired by his
work(some parts copied). You can see his [blog](https://invent.life/project/bash-infinity-framework) too that is really
interesting