A working skeleton for a new tui-tools tool
The starting point for a new tool in the family. Press Use this template, rename it, replace one package, and you have a tool that looks and behaves like the rest.
It is not a pile of TODOs: it is a working tool. It lists the files in a directory and can update a file's timestamp, which is deliberately trivial — what matters is the shape around it, and that shape is already correct: the action table that generates the key map, the help screen and the confirm dialog; the backend interface with a real and a fake implementation; --demo; CI; and GoReleaser.
This tool.json is itself the example. It is a valid manifest, validated against the schema on every CI run, and the values are the ones you replace.
| Key | Action |
|---|---|
| t | Touch the selected file |
| / | Filter the list |
| r / ctrl+r | Re-read the directory |
| ? | Help |
| q | Quit |
Press ? inside the tool for the full help screen, which is generated from the same action table as the key map.
This tool is a face on the program below, so its version matters.Tested is not a claim: a version lands there only after the tool's own suite passed against it on a real machine in the lab, and the run is kept as evidence in the repository. At startup the tool probes the backend once and says what it found in its header — a version nobody has run against is shown as(untested) in the warning colour, one older than the minimum as (below minimum) in the error colour. Neither stops it: the backend still refuses what it cannot do, in its own words.
touch8.0touch --versionno-dereferencesince 8.1coreutils <8.1touch -h is missing, so the timestamp of a symlink is set on its target instead of on the link
Once per machine, then every tool in the family is one pacman away.
$ curl -fsSL https://pkgs.tui.tools/install.sh | shA family whose whole promise is preview before you run is not going to insist you pipe a script into a shell. These are the commands that script runs.
$ curl -fsSL -o /tmp/tui-tools.asc https://pkgs.tui.tools/pubkey.asc
sudo pacman-key --add /tmp/tui-tools.asc
sudo pacman-key --lsign-key \
"$(gpg --show-keys --with-colons /tmp/tui-tools.asc | awk -F: '/^fpr:/{print $10; exit}')"
printf '[tui-tools]\nServer = https://pkgs.tui.tools/arch/$arch\n' \
| sudo tee -a /etc/pacman.conf
sudo pacman -Sy$ sudo pacman -S tui-templateThe template is never packaged. Your tool's channel turns available once its first release lands in pkgs.tui.tools.
Once per machine, then every tool in the family is one apt away.
$ curl -fsSL https://pkgs.tui.tools/install.sh | shA family whose whole promise is preview before you run is not going to insist you pipe a script into a shell. These are the commands that script runs.
$ sudo install -d -m 0755 /etc/apt/keyrings
curl -fsSL https://pkgs.tui.tools/pubkey.asc \
| sudo gpg --dearmor -o /etc/apt/keyrings/tui-tools.gpg
echo "deb [signed-by=/etc/apt/keyrings/tui-tools.gpg] https://pkgs.tui.tools/deb stable main" \
| sudo tee /etc/apt/sources.list.d/tui-tools.list
sudo apt update$ sudo apt install tui-templateThe template is never packaged. Your tool's channel turns available once its first release lands in pkgs.tui.tools.
Once per machine, then every tool in the family is one dnf away.
$ curl -fsSL https://pkgs.tui.tools/install.sh | shA family whose whole promise is preview before you run is not going to insist you pipe a script into a shell. These are the commands that script runs.
$ sudo rpm --import https://pkgs.tui.tools/pubkey.asc
sudo curl -fsSL -o /etc/yum.repos.d/tui-tools.repo https://pkgs.tui.tools/rpm/tui-tools.repo
sudo dnf makecache$ sudo dnf install tui-templateThe template is never packaged. Your tool's channel turns available once its first release lands in pkgs.tui.tools.
$ curl -fsSL https://github.com/tui-tools/tui-template/releases/download/v0.0.0/tui-template_0.0.0_linux_amd64.tar.gz | tar -xz tui-template
sudo install -m0755 tui-template /usr/local/bin/tui-template$ curl -fsSL https://github.com/tui-tools/tui-template/releases/download/v0.0.0/tui-template_0.0.0_linux_arm64.tar.gz | tar -xz tui-template
sudo install -m0755 tui-template /usr/local/bin/tui-templateThe template is never released. Your tool is, once you tag v0.1.0.
$ git clone https://github.com/tui-tools/tui-template
cd tui-template && make demoOr press "Use this template" on GitHub, which is the point of it.
Every change is shown as an exact command line and confirmed before it runs. The dialog and the runner receive the same value, so the preview cannot drift from what executes.
Only the touch action escalates, and only when the configured prefix is non-empty. Listing a directory is an ordinary read. Replace this sentence with what your own tool escalates for.
Nothing keeps running after you quit, and nothing is installed to run later. The system is the source of truth; the tool re-reads it after every change.
The tool opens no network connection of its own. No telemetry, no update check, no phone home.
Released statically linked, with no runtime dependencies to install.
Releases carry SHA-256 checksums but no signature. Verify the checksum, and read this as the open item it is.
Report a security issue privately, through GitHub's private vulnerability reporting on the repository's Security tab. The family-wide policy, and what counts as in scope, is on the security page.