mirror/timo-reymann.bash-tui-toolkit
1
0
Fork 0
mirror of https://github.com/timo-reymann/bash-tui-toolkit.git synced 2025-09-08 10:27:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Toolkit to create simple Terminal UIs using plain bash builtins http://bash-tui-toolkit.timo-reymann.de/
120 commits 3 branches 26 tags 326 KiB
Find a file
Exact
semantic-release-bot baff8e298e chore(release): 1.10.0 [skip ci] 
## [1.10.0](https://github.com/timo-reymann/bash-tui-toolkit/compare/1.9.0...1.10.0) (2025-08-01)

### Features

* [[#38](https://github.com/timo-reymann/bash-tui-toolkit/issues/38)] Add possibility to preselect checkbox items ([a152047](a152047da5))
2025-08-01 23:18:58 +00:00
.circleci chore(deps): update dependency shellcheck to v3.4.0 2025-03-05 22:47:19 +01:00
.development chore(deps): update golang docker tag to v1.24 2025-02-14 08:51:00 +01:00
.github/images docs: Add new structure for README 2023-02-18 17:41:54 +01:00
docs feat: [#38] Add possibility to preselect checkbox items 2025-08-02 01:17:35 +02:00
scripts chore(scripts): Clear docs before uploading 2025-01-03 15:28:12 +01:00
src feat: [#38] Add possibility to preselect checkbox items 2025-08-02 01:17:35 +02:00
.gitignore chore: Add build 2023-02-15 13:25:16 +01:00
.pre-commit-config.yaml chore(deps): update pre-commit hook zahorniak/pre-commit-circleci to v1.2.0 [skip ci] (#39) 2025-04-28 19:59:16 +00:00
.releaserc.json fix: Set release version on semantic-release 2023-06-26 15:46:16 +02:00
CHANGELOG.md chore(release): 1.10.0 [skip ci] 2025-08-01 23:18:58 +00:00
CONTRIBUTING.md docs: Fix contribution license 2023-02-18 21:49:03 +01:00
LICENSE feat: Add first modules 2023-02-15 00:19:14 +01:00
Makefile fix: Set release version on semantic-release 2023-06-26 15:46:16 +02:00
README.md docs(readme): Fix docs links 2025-01-03 22:44:37 +01:00
renovate.json chore: Add build 2023-02-15 13:25:16 +01:00
test.sh test: Add manual test for checkbox preselect 2025-08-02 01:17:51 +02:00

README.md

Bash TUI Toolkit

LICENSE CircleCI GitHub Release Renovate pre-commit GitHub Downloads (all assets, all releases)


Toolkit to create interactive and shiny terminal UIs using plain bash builtins

Features

  • clean and standardized API
  • provide a simple and clear default set of elements to use creating an interactive terminal UI
  • clean and minimalistic design
  • zero dependencies to be installed
  • parts can be used modular

Requirements

Installation

Download and include in your scripts

  1. Download the bundle (entire lib) or single compoennt from releases
  2. Source the bundle in your script or embed, e.g. 
    source ./lib/bundle.bash
    or simply copy it into your script.

Source directly from release

Note that this is not a recommended approach and only intended for quick testing or trying out another version.

  1. Choose the bundle in the version you want to use from the available releases in the docs.
  2. Source it to your script on runtime:
    1. Using wget 
      source <(wget -qO- https://bash-tui-toolkit.timo-reymann.de/latest/bundle.bash)
    2. Using curl 
      source <(curl -qsS https://bash-tui-toolkit.timo-reymann.de/latest/bundle.bash)

Usage

For a list of available modules and their documentation please check the docs.

For a complete playground demo check test.sh.

Motivation

Providing a clean bash UI sometimes becomes a mess and interactivity is hard to achieve especially when it should be portable.

The target is to provide a simple-to-use toolkit that can be dropped into any bash script and is compatible no matter the target system.

Documentation

  • GitHub Pages - Versioned releases, documentation and compability matrix
  • Modules - Modules available and their usage
  • Compability table - Known combinations of OS/Bash Version/Terminal emulators that work guaranteed

Contributing

I love your input! I want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the configuration
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

To get started please read the Contribution Guidelines.

Development

Requirements

Build

make build

Update documentation

To update the module documentation you just need to run

make generate-docs

This builds the documentation inside a docker container and updates the repo locally. Afterwards just commit the docs with your code changes

Credits

Alternatives