https://github.com/flarebyte/baldrick-pest

Cunning regression tests for CLI applications
https://github.com/flarebyte/baldrick-pest

cli npm-cli regression-testing testing

Last synced: 17 days ago
JSON representation

Cunning regression tests for CLI applications

• Host: GitHub
• URL: https://github.com/flarebyte/baldrick-pest
• Owner: flarebyte
• License: mit
• Created: 2022-11-04T20:41:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-09-21T09:57:05.000Z (10 months ago)
• Last Synced: 2025-09-21T11:27:09.270Z (10 months ago)
• Topics: cli, npm-cli, regression-testing, testing
• Language: TypeScript
• Homepage:
• Size: 1.23 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Agents: AGENTS.md

Awesome Lists containing this project

README

          
# baldrick-pest

![npm](https://img.shields.io/npm/v/baldrick-pest) ![Build

status](https://github.com/flarebyte/baldrick-pest/actions/workflows/main.yml/badge.svg)

![npm bundle size](https://img.shields.io/bundlephobia/min/baldrick-pest)

![npm type definitions](https://img.shields.io/npm/types/baldrick-pest)

![node-current](https://img.shields.io/node/v/baldrick-pest)

![NPM](https://img.shields.io/npm/l/baldrick-pest)

![Experimental](https://img.shields.io/badge/status-experimental-blue)

> Cunning regression tests for CLI applications

Snapshot-driven acceptance tests for CLI apps defined in YAML.

Snapshot-driven acceptance tests for any CLI.

![Hero image for baldrick-pest](baldrick-pest-hero-512.jpeg)

Highlights:

- Test any kind of executable regardless of the programming language it has been created with.

- Tests are written in YAML with a json schema.

- Regression are checked by making snapshots.

- Writing tests is quick and easy with auto-completion in vs-code

- Reports the test results in mocha json. This makes it easy to integrate with

  other tools and services that use mocha json as a standard format for test

  results.

![Example of baldrick-pest usage](baldrick-pest-usage.gif "demo")

## Documentation and links

- [Code Maintenance :wrench:](MAINTENANCE.md)

- [Code Of Conduct](CODE_OF_CONDUCT.md)

- [Api for baldrick-pest](API.md)

- [Contributing :busts_in_silhouette: :construction:](CONTRIBUTING.md)

- [Diagram for the code base :triangular_ruler:](INTERNAL.md)

- [Vocabulary used in the code base :book:](CODE_VOCABULARY.md)

- [Architectural Decision Records :memo:](DECISIONS.md)

- [Contributors :busts_in_silhouette:](https://github.com/flarebyte/baldrick-pest/graphs/contributors)

- [Dependencies](https://github.com/flarebyte/baldrick-pest/network/dependencies)

- [Glossary :book:](https://github.com/flarebyte/overview/blob/main/GLOSSARY.md)

- [Software engineering principles :gem:](https://github.com/flarebyte/overview/blob/main/PRINCIPLES.md)

- [Overview of Flarebyte.com ecosystem :factory:](https://github.com/flarebyte/overview)

- [Usage ★★](USAGE.md)

- [Overview for the json schema for baldrick pest yaml file](SCHEMA.md)

- [Json schema for baldrick pest yaml

  file](spec/snapshots/pest-model/get-schema--schema.json)

## Related

- [baldrick-zest-engine](https://github.com/flarebyte/baldrick-zest-engine) Run tests declaratively with a few cunning plans

- [assert sh](https://github.com/lehmannro/assert.sh) test-driven development for bash

- [bash_unit](https://github.com/pgrange/bash_unit) bash unit testing enterprise edition framework

- [shUnit2](https://github.com/kward/shunit2) unit test framework for Bourne based shell scripts

## Installation

This package is [ESM

only](https://blog.sindresorhus.com/get-ready-for-esm-aa53530b3f77).

```bash

yarn global add baldrick-pest

baldrick-pest --help

```

Or alternatively run it:

```bash

npx baldrick-pest --help

```

If you want to tun the latest version from github. Mostly useful for dev:

```bash

git clone git@github.com:flarebyte/baldrick-pest.git

yarn global add `pwd`

```