clitest(1)

💖 clitest(1) — the manual page, but make it a group chat 💖

okay bestie, buckle up, we're reading clitest(1) together and it's genuinely iconic. it does automatic testing in command lines. yes. that clitest. 🎀

✨ NAME ✨

clitest — performs automatic testing in command lines 🦋

✨ SYNOPSIS ✨

clitest [options] <file ...>

✨ DESCRIPTION ✨

so like, Clitest is a portable POSIX shell script that performs automatic testing in Unix command lines. and not me being obsessed with this detail — this script was carefully coded to be portable between POSIX shells. like, carefully. someone put their whole heart into that. 💅

it's the same concept as Python's doctest module, fr fr: you document both the commands and their expected output, using the familiar interactive prompt format, and a specialized tool tests them. you write down what you ran and what it spit back out, and the tool goes "bet, let me verify that" 🫶

and here's the main character energy: the clitest command searches for pieces of text that look like interactive Unix command lines, and then executes those command lines to verify that they work exactly as shown. exactly as shown. no vibes-based approximation. periodt. 👑

✨ OPTIONS ✨

• -1, --first — stop execution upon first failed test. like, we're done here, first L and we're out 💀
• -l, --list — list all the tests, no execution. just showing you the lineup, no performance 🌸
• -L, --list-run — list all the tests with OK/FAIL status. the receipts, bestie 🧾
• -t, --test RANGE — run specific tests, by number (1,2,4-7) 🎯
• -s, --skip RANGE — skip specific tests, by number (1,2,4-7) 🙈
• -q, --quiet — quiet operation, no output shown. silent. mysterious. lowkey 🤫
• -V, --version — show program version and exit 🌟
• -P, --progress TYPE — set progress indicator: test, number, dot, none ✨
• --pre-flight COMMAND — execute COMMAND before running the first test 🚀
• --post-flight COMMAND — execute COMMAND after running the last test 🛬
• --color WHEN — set when to use colors: auto, always, never 🌈
• --diff-options OPTIONS — set diff command options (default: '-u') 🔍
• --inline-prefix PREFIX — set inline output prefix (default: '#→ ') 💜
• --prefix PREFIX — set command line prefix (default: '') 🎀
• --prompt STRING — set prompt string (default: '$ ') 💖

ngl, those defaults are literally written out exactly like that, so copy them character for character if you're typing them in. no guessing, no "close enough", bestie. 😭

✨ AUTHOR ✨

The CLITEST was written by Aurelio Jargas <verde@aurelio.net>. 🫶

This manual page was written by Giovani Augusto Ferreira <giovani@riseup.net> for the Debian project (but may be used by others). 🌸

and that's the whole page, bestie!! CLITEST 0.0, from Oct 2015, manual page clitest(1) — that's the source, version and date, all folded into this cute lil sign-off because you deserve the aesthetic 💅✨ bye ily, go test your command lines 💖