CLI.PY(1)

💖 CLI.PY 💖

okay bestie, gather round, because this is the manual page for cli.py from the User Commands manual, and it's genuinely iconic. it's a BDD test engine based on Vows.js and it's about to be your whole personality. 🎀

---

✨ NAME ✨

cli.py — BDD test engine based on Vows.js 🦋

---

🌸 DESCRIPTION 🌸

so the vibe is: you run it, and it runs your tests. that's it, that's the dream. here's the usage, no cap:

usage: cli.py [-h] [-p PATTERN] [-e EXCLUDE]
              [-i INCLUDE] [-c] [-l PACKAGE] [-o FILE] [-t NUMBER] [-r FILE]
              [-x] [-f FILE] [--profile] [--profile-threshold NUM] [--template]
              [--no-color] [--progress] [--version] [--capture-output] [-v]
              [path]

Run PyVows tests. periodt. 💅

---

🫶 positional arguments: 🫶

• path — the directory to go looking for vows in, recursively (it's giving detective energy 🔍). if you hand it a file instead of a directory, then that file is the target for vows. (default: '.'). yes queen, it defaults to the current directory.

---

⭐ options: ⭐

• -h, --help — shows this help message and then dips out. bye bestie 👋
• -p PATTERN, --pattern PATTERN — the pattern your vows files have to match. (default: '*_vows.py')
• -e EXCLUDE, --exclude EXCLUDE — excludes tests and contexts that match the regex-pattern EXCLUDE. ⚠️ mutually exclusive with --include — you cannot have both, pick a lane.
• -i INCLUDE, --include INCLUDE — includes only tests and contexts that match the regexpattern INCLUDE. ⚠️ mutually exclusive with --exclude — same deal, one or the other, no cap.
• --no-color — turns off the colorized output. (default: False) 😭 the aesthetic loss fr
• --progress — shows progress ticks while testing is happening. (default: False)
• --version — shows the program's version number and then exits. iconic.
• --capture-output — captures stdout and stderr while tests are executing (default: False)
• -v — verbosity. you can specify it many times to keep cranking the verbosity up (default: -vv). the way that more -v = more talking, we love a chatty queen 🗣️

---

🧚 Test Coverage: 🧚

• -c, --cover — shows you the code coverage of your tests. (default: False)
• -l PACKAGE, --cover-package PACKAGE — verifies coverage of PACKAGE. may be specified many times. (default: all packages)
• -o FILE, --cover-omit FILE — excludes FILE from coverage. may be specified many times. (default: no files)
• -t NUMBER, --cover-threshold NUMBER — if coverage drops below NUMBER, that's considered a failure. (default: 80.0)
• -r FILE, --cover-report FILE — stores the coverage report as FILE. (default: None)

---

💜 XUnit: 💜

• -x, --xunit-output — enables XUnit output. (default: False)
• -f FILE, --xunit-file FILE — stores the XUnit output as FILE. (default: 'pyvows.xml')

---

🔥 Profiling: 🔥

• --profile — prints the 10 slowest topics. (default: False)
• --profile-threshold NUM — tests that take longer than NUM seconds get labeled slow. (default: 0.1)

---

🌈 Utility: 🌈

• --template — prints a PyVows test file template. heads up: this disables testing. (Disables testing)

---

💖 reminder bestie: --exclude and --include are mutually exclusive, so don't try to run both and then act surprised. the manpage said what it said.

---

and that's the whole page, you ate it, no crumbs. 🍓 this was cli.py version 3.0.0, from December 2022 — slay, go write some vows, main character energy only. ✨👑💅